Revit API Documentation

https://revapidocs.com/2023.htm
Admin
API documentation for Autodesk Revit, covering classes, namespaces, and API changes across the Revit...
Tokens:12,237
Snippets:131
Trust Score:5.2
Update:5 months ago
Show doc for...
Tokens:
Raw
### Events API Additions - SelectionChangedEventArgs

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

Event arguments for the SelectionChanged event, providing methods to get references and the associated document.

```APIDOC
## Autodesk.Revit.UI.Events.SelectionChangedEventArgs

### Description
The event arguments used by the SelectionChanged event.

### SelectionChangedEventArgs.GetReferences()

#### Description
Returns the selected references.

#### Method
SelectionChangedEventArgs.GetReferences()

### SelectionChangedEventArgs.GetDocument()

#### Description
Returns the document associated with this event.

#### Method
SelectionChangedEventArgs.GetDocument()
```

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

### AnalyticalTransferSwitchData.GetTotalCurrent

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

Gets the total connected current of an electrical analytical transfer switch.

```APIDOC
## AnalyticalTransferSwitchData.GetTotalCurrent()

### Description
Gets the total connected current of the electrical analytical transfer switch.

### Method
Method

### Endpoint
AnalyticalTransferSwitchData

### Parameters
None explicitly documented.

### Request Example
None explicitly documented.

### Response
None explicitly documented.
```

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

### Project Browser API Additions

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

New property for BrowserOrganization type and a new class for ProjectBrowserOptions.

```APIDOC
## Autodesk.Revit.DB.BrowserOrganization.Type

### Description
Represents the browser organization type.

## ProjectBrowserOptions

### Description
Provides access to settings that control Revit's Project Browser appearance and functionality. These settings are stored in the Revit.ini file and affect all documents using this file.

### ProjectBrowserOptions.ShowViewPlacementOnSheetStatusIcons

#### Description
Shows icons indicating view placement on sheet status. If true, icons are shown at every view or schedule node in the Project Browser. If false, they are not shown.

#### Property
ProjectBrowserOptions.ShowViewPlacementOnSheetStatusIcons (boolean)
```

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

### AXM Import API

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

Allows importing AXM files into the document with specified options.

```APIDOC
## Document.Import(String, AXMImportOptions, View)

### Description
Imports an AXM file into the document with the specified import options.

### Method
Document.Import(String, AXMImportOptions, View)

### Parameters
- **filePath** (String) - The path to the AXM file.
- **options** (AXMImportOptions) - The import options.
- **view** (View) - The view to import into.
```

```APIDOC
## OptionalFunctionalityUtils.IsAXMImportLinkAvailable()

### Description
Checks if the AXM import functionality is available.

### Method
OptionalFunctionalityUtils.IsAXMImportLinkAvailable()

### Returns
(bool) True if AXM import is available, false otherwise.
```

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

### STL and OBJ Import & Link API

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

Provides methods for importing and linking STL and OBJ files into the Revit document.

```APIDOC
## Document.Import(String, OBJImportOptions, View)

### Description
Imports an OBJ file into the document.

### Method
Document.Import(String, OBJImportOptions, View)

### Parameters
- **filePath** (String) - The path to the OBJ file.
- **options** (OBJImportOptions) - The import options.
- **view** (View) - The view to import into.
```

```APIDOC
## Document.Import(String, STLImportOptions, View)

### Description
Imports an STL file into the document.

### Method
Document.Import(String, STLImportOptions, View)

### Parameters
- **filePath** (String) - The path to the STL file.
- **options** (STLImportOptions) - The import options.
- **view** (View) - The view to import into.
```

```APIDOC
## ImportInstance.Create(Document, View, ExternalResourceReference, OBJImportOptions, [out] LinkLoadResult)

### Description
Creates an imported instance from an OBJ file.

### Method
ImportInstance.Create(Document, View, ExternalResourceReference, OBJImportOptions, [out] LinkLoadResult)

### Parameters
- **document** (Document) - The current document.
- **view** (View) - The view to place the instance in.
- **resourceReference** (ExternalResourceReference) - Reference to the OBJ file.
- **options** (OBJImportOptions) - The import options.
- **loadResult** ([out] LinkLoadResult) - Output parameter for the link load result.
```

```APIDOC
## ImportInstance.Create(Document, View, ExternalResourceReference, STLImportOptions, [out] LinkLoadResult)

### Description
Creates an imported instance from an STL file.

### Method
ImportInstance.Create(Document, View, ExternalResourceReference, STLImportOptions, [out] LinkLoadResult)

### Parameters
- **document** (Document) - The current document.
- **view** (View) - The view to place the instance in.
- **resourceReference** (ExternalResourceReference) - Reference to the STL file.
- **options** (STLImportOptions) - The import options.
- **loadResult** ([out] LinkLoadResult) - Output parameter for the link load result.
```

```APIDOC
## Document.Link(String, OBJImportOptions, View)

### Description
Links an OBJ file into the document.

### Method
Document.Link(String, OBJImportOptions, View)

### Parameters
- **filePath** (String) - The path to the OBJ file.
- **options** (OBJImportOptions) - The import options.
- **view** (View) - The view to link into.
```

```APIDOC
## Document.Link(String, STLImportOptions, View)

### Description
Links an STL file into the document.

### Method
Document.Link(String, STLImportOptions, View)

### Parameters
- **filePath** (String) - The path to the STL file.
- **options** (STLImportOptions) - The import options.
- **view** (View) - The view to link into.
```

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

### Boundary Conditions API Changes

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

Details the change in the HostElement property for BoundaryConditions.

```APIDOC
## Boundary Conditions API Changes

### Description
This section describes the modification to the HostElement property within the BoundaryConditions class.

### Removed API: Autodesk.Revit.DB.Structure.BoundaryConditions.HostElement
- **Replacement**: HostElementId
```

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

### Line Load, Area Load, Point Load API Changes

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

Details the removed and replaced methods for creating Line Load, Area Load, and Point Load objects.

```APIDOC
## Line Load, Area Load, Point Load API Changes

### Description
This section details the changes in the API for creating Line Load, Area Load, and Point Load objects, highlighting removed methods and their replacements.

### Removed API: Autodesk.Revit.DB.Structure.LineLoad.Create
- **Replacement**: Autodesk.Revit.DB.Structure.LineLoad.Create(Document doc, hostElemId, XYZ forceVector1, XYZ momentVector1, LineLoadType symbol)

### Removed API: Autodesk.Revit.DB.Structure.LineLoad.Create
- **Replacement**: Autodesk.Revit.DB.Structure.LineLoad.Create(Document doc, hostElemId, int curveIndex, XYZ forceVector1, XYZ momentVector1, LineLoadType symbol)

### Removed API: Autodesk.Revit.DB.Structure.AreaLoad.Create
- **Replacement**: Autodesk.Revit.DB.Structure.AreaLoad.Create(Document doc, hostElemId, XYZ forceVector1, AreaLoadType symbol)

### Removed API: Autodesk.Revit.DB.Structure.PointLoad.Create
- **Replacement**: Autodesk.Revit.DB.Structure.PointLoad.Create(Document doc, hostId, AnalyticalElementSelector selector, XYZ forceVector, XYZ momentVector, PointLoadType symbol)

### Removed API: Autodesk.Revit.DB.Structure.PointLoad.Create
- **Replacement**: None
```

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

### Structure API Additions - Line Load

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

Methods for creating hosted line loads and checking host validity for line loads.

```APIDOC
## Autodesk.Revit.DB.Structure.LineLoad.Create(Document aDoc, ElementId hostElemId, XYZ forceVector1, XYZ momentVector1, LineLoadType symbol)

### Description
Creates a new hosted line load within the project.

### Method
Autodesk.Revit.DB.Structure.LineLoad.Create(Document aDoc, ElementId hostElemId, XYZ forceVector1, XYZ momentVector1, LineLoadType symbol)

## Autodesk.Revit.DB.Structure.LineLoad.Create(Document aDoc, ElementId hostElemId, int curveIndex, XYZ forceVector1, XYZ momentVector1, LineLoadType symbol)

### Description
Creates a new hosted line load within the project.

### Method
Autodesk.Revit.DB.Structure.LineLoad.Create(Document aDoc, ElementId hostElemId, int curveIndex, XYZ forceVector1, XYZ momentVector1, LineLoadType symbol)

## Autodesk.Revit.DB.Structure.AreaLoad.isValidHostId()

### Description
Indicates if the provided host id can host line loads.

### Method
Autodesk.Revit.DB.Structure.AreaLoad.isValidHostId()
```

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

### Structure API Additions - Point Load

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

Methods for creating hosted point loads and checking host validity for point loads.

```APIDOC
## Autodesk.Revit.DB.Structure.PointLoad.Create()

### Description
Creates a new hosted point load within the project.

### Method
Autodesk.Revit.DB.Structure.PointLoad.Create()

## Autodesk.Revit.DB.Structure.PointLoad.isValidHostId()

### Description
Indicates if the provided host id can host point loads.

### Method
Autodesk.Revit.DB.Structure.PointLoad.isValidHostId()
```

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

### Selection API Additions

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

Methods for selecting references and retrieving selected references, along with new events for selection changes.

```APIDOC
## Autodesk.Revit.UI.Selection.SetReferences()

### Description
Selects the references. The references can be an element or a sub-element in the host or a linked document.

### Method
Autodesk.Revit.UI.Selection.SetReferences()

## Autodesk.Revit.UI.Selection.GetReferences()

### Description
Returns the references that are currently selected.

### Method
Autodesk.Revit.UI.Selection.GetReferences()

## Autodesk.Revit.UI.UIApplication.SelectionChanged

### Description
Subscribe to the SelectionChange event to be notified after the selection was changed.

### Event
Autodesk.Revit.UI.UIApplication.SelectionChanged

## Autodesk.Revit.UI.UIControlledApplication.SelectionChanged

### Description
Subscribe to the SelectionChange event to be notified after the selection was changed.

### Event
Autodesk.Revit.UI.UIControlledApplication.SelectionChanged
```

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

### Viewport Transformation Methods

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

Methods for transforming between view projection space and sheet space, and checking for viewport transforms.

```APIDOC
## Viewport.GetProjectionToSheetTransform()

### Description
Transforms from a view's projection space to sheet space.

### Method
Method

### Endpoint
Viewport.GetProjectionToSheetTransform()

## Viewport.HasViewportTransforms()

### Description
Checks if the viewport has any associated transforms.

### Method
Method

### Endpoint
Viewport.HasViewportTransforms()
```

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

### Autodesk.Revit.DB.Mechanical.Zone.CreateAreaBasedLoad

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

Creates a new instance of an area based load and adds it to the document.

```APIDOC
## Autodesk.Revit.DB.Mechanical.Zone.CreateAreaBasedLoad()

### Description
Creates a new instance of an area based load and adds it to the document.

### Method
Method

### Endpoint
Autodesk.Revit.DB.Mechanical.Zone

### Parameters
None explicitly documented.

### Request Example
None explicitly documented.

### Response
None explicitly documented.
```

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

### AreaBasedLoadData Methods

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

Methods for managing electrical load areas within the AreaBasedLoadData class.

```APIDOC
## AreaBasedLoadData.AddElectricalLoadArea()

### Description
Adds an electrical load area to the area based load.

### Method
Method

### Endpoint
AreaBasedLoadData

### Parameters
None explicitly documented.

### Request Example
None explicitly documented.

### Response
None explicitly documented.
```

```APIDOC
## AreaBasedLoadData.GetElectricalLoadAreas()

### Description
Retrieves the electrical load areas included in the area based load.

### Method
Method

### Endpoint
AreaBasedLoadData

### Parameters
None explicitly documented.

### Request Example
None explicitly documented.

### Response
None explicitly documented.
```

```APIDOC
## AreaBasedLoadData.RemoveElectricalLoadArea()

### Description
Removes an electrical load area from the area based load.

### Method
Method

### Endpoint
AreaBasedLoadData

### Parameters
None explicitly documented.

### Request Example
None explicitly documented.

### Response
None explicitly documented.
```

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

### Dimension and Filled Region Creation in Sketch Edit Mode

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

Methods for creating dimensions and filled regions within sketch edit mode, requiring specific parameters for sketch entities and null view.

```APIDOC
## Document.NewDimension()

### Description
Supports creation of dimensions in Sketch Edit mode. Must be called under sketch edit mode, passing the view parameter as null and using sketch entities as dimension references.

### Method
Document.NewDimension()

### Parameters
- **view** (null) - Must be null when creating dimensions in sketch edit mode.
- **dimension references** (sketch entities) - References for the dimension must be sketch entities.

## Document.NewFamilyInstance()

### Description
Supports creation of family instances in Sketch Edit mode. Must be called under sketch edit mode, passing the view parameter as null and using sketch entities as dimension references.

### Method
Document.NewFamilyInstance()

### Parameters
- **view** (null) - Must be null when creating family instances in sketch edit mode.
- **dimension references** (sketch entities) - References for the dimension must be sketch entities.

## FilledRegion.Create()

### Description
Creates a filled region on a sketch plane in a 3D family.

### Method
FilledRegion.Create()
```

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

### ElectricalLoadAreaData Methods

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

Methods for managing electrical load area data.

```APIDOC
## ElectricalLoadAreaData.CreateElectricalLoadAreas()

### Description
Creates electrical load areas on all empty plan circuits of a given level.

### Method
Method

### Endpoint
ElectricalLoadAreaData

### Parameters
None explicitly documented.

### Request Example
None explicitly documented.

### Response
None explicitly documented.
```

```APIDOC
## ElectricalLoadAreaData.HasCircuitsWithoutElectricalLoadAreas()

### Description
Checks if there are any empty plan circuits without electrical load areas.

### Method
Method

### Endpoint
ElectricalLoadAreaData

### Parameters
None explicitly documented.

### Request Example
None explicitly documented.

### Response
None explicitly documented.
```

```APIDOC
## ElectricalLoadAreaData.GetAreaBasedLoadIds()

### Description
Retrieves the area based load IDs to be included for the electrical load area.

### Method
Method

### Endpoint
ElectricalLoadAreaData

### Parameters
None explicitly documented.

### Request Example
None explicitly documented.

### Response
None explicitly documented.
```

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

### Structure API Additions - Rebar Propagation

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

Utility class and methods for propagating rebar elements, including alignment by host and face.

```APIDOC
## RebarPropagation.AlignByHost()

### Description
Copies source rebars, aligns them based on the source host's alignment to the destination host, and adapts them to the destination host.

### Method
RebarPropagation.AlignByHost()

## RebarPropagation.AlignByFace()

### Description
Copies source rebars, aligns them to the destination face based on the source face, and adapts them to the destination host.

### Method
RebarPropagation.AlignByFace()
```

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

### OBJ Export API

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

Supports exporting Revit geometry to OBJ format with various tessellation settings.

```APIDOC
## Document.Export(String, String, OBJExportOptions)

### Description
Exports Revit geometry to OBJ format.

### Method
Document.Export(String, String, OBJExportOptions)

### Parameters
- **filePath** (String) - The path to save the OBJ file.
- **name** (String) - The name of the export.
- **options** (OBJExportOptions) - The export options.
```

```APIDOC
## OBJExportOptions

### Description
Contains options for exporting Revit geometry to OBJ format.

### Properties
- **TargetUnit** (UnitType) - The target unit for the export.
- **SurfaceTolerance** (double) - The surface tolerance for tessellation.
- **NormalTolerance** (double) - The normal tolerance for tessellation.
- **MaxEdgeLength** (double) - The maximum edge length for tessellation.
- **GridAspectRatio** (double) - The grid aspect ratio for tessellation.

### Methods
- **SetTessellationSettings()** - Sets the tessellation settings for the export.
```

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

### AreaBasedLoadBoundaryLineData Methods

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

Methods for accessing and checking data related to area based load boundary lines.

```APIDOC
## AreaBasedLoadBoundaryLineData.GetLevelIdsInRange()

### Description
Returns level IDs between the top and bottom levels (inclusive) of the area based load boundary line.

### Method
Method

### Endpoint
AreaBasedLoadBoundaryLineData

### Parameters
None explicitly documented.

### Request Example
None explicitly documented.

### Response
None explicitly documented.
```

```APIDOC
## AreaBasedLoadBoundaryLineData.IsElevationWithinRange()

### Description
Checks if a given elevation is within the range of the bottom and top levels (inclusive) of the area based load boundary line.

### Method
Method

### Endpoint
AreaBasedLoadBoundaryLineData

### Parameters
None explicitly documented.

### Request Example
None explicitly documented.

### Response
None explicitly documented.
```

```APIDOC
## AreaBasedLoadBoundaryLineData.IsLevelWithinRange()

### Description
Checks if a given level is within the range of the bottom and top levels (inclusive) of the area based load boundary line.

### Method
Method

### Endpoint
AreaBasedLoadBoundaryLineData

### Parameters
None explicitly documented.

### Request Example
None explicitly documented.

### Response
None explicitly documented.
```

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

### Load Base API Changes

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

Details the change in the HostElement property for LoadBase.

```APIDOC
## Load Base API Changes

### Description
This section describes the modification to the HostElement property within the LoadBase class.

### Removed API: Autodesk.Revit.DB.Structure.LoadBase.HostElement
- **Replacement**: HostElementId
```

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

### Geometry API Changes - Bounding Box

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

Updates to the BoundingBoxXYZ class description regarding empty bounding boxes.

```APIDOC
## Geometry API Changes - Bounding Box

### Description
The description for the BoundingBoxXYZ class has been updated to clarify that a bounding box might not be empty even if the element's Geometry property returns an empty result. This is because GetBoundingBox does not consider the Geometry property's Options.

### Class: BoundingBoxXYZ
- **Description Update**: Mentions that the bounding box might not be empty even if the element's Geometry property returns an empty result, as GetBoundingBox does not take the Geometry property's Options into account.
```

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

### ViewSchedule.GetScheduleInstances()

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

Retrieves all schedule sheet instances for a given schedule segment.

```APIDOC
## Method: ViewSchedule.GetScheduleInstances()

### Description
Returns a collection of `ScheduleSheetInstance` objects that represent all instances of a schedule segment placed on sheets.

### Returns
- `ICollection<ScheduleSheetInstance>`: A collection of schedule sheet instances.
```

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

### View Projection Space Transformation API

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

Provides methods to transform between model space and a view's projection space.

```APIDOC
## TransformWithBoundary.GetModelToProjectionTransform()

### Description
Gets the transform from model space to the view's projection space.

### Method
TransformWithBoundary.GetModelToProjectionTransform()

### Returns
(Transform) The transform object.
```

```APIDOC
## TransformWithBoundary.GetBoundary()

### Description
Returns the boundary for the model space to view projection space transform.

### Method
TransformWithBoundary.GetBoundary()

### Returns
(Boundary) The boundary object.
```

```APIDOC
## View.GetModelToProjectionTransforms()

### Description
Gets the transforms from model space to the view projection space. Views with split crop regions may have more than one transform.

### Method
View.GetModelToProjectionTransforms()

### Returns
(IList<Transform>) A list of transform objects.
```

```APIDOC
## View.HasViewTransforms()

### Description
Returns true if the view reports model space to view projection space transforms. Schedules and legends, for example, do not report any.

### Method
View.HasViewTransforms()

### Returns
(bool) True if the view has transforms, false otherwise.
```

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

### Swapping Viewports on Sheets

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

Editable property and new members for managing viewport view IDs and positioning.

```APIDOC
## Viewport.ViewId Property

### Description
Represents the ID of the view associated with the viewport. This property is now editable, allowing the associated view to be swapped.

### Method
Property (Editable)

### Endpoint
Viewport.ViewId

## Viewport.ViewportPositioning Enum

### Description
Specifies how the viewport will be positioned on the sheet when swapped to another view. Options include ViewportPositioning.ViewportCenter (default) and ViewportPositioning.ViewOrigin.

## Viewport.IsViewIdValidForViewport()

### Description
Verifies if the Viewport can change its view ID to the input viewId. Returns true if the viewId is valid for the viewport, false otherwise.

### Method
Method

### Endpoint
Viewport.IsViewIdValidForViewport(viewId)
```

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

### Structure API Additions - RebarHostData

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

Method to identify if an element containing a reference can host reinforcement.

```APIDOC
## RebarHostData.IsReferenceContainedByAValidHost()

### Description
Identifies whether an element that contains the given reference can host reinforcement.

### Method
RebarHostData.IsReferenceContainedByAValidHost()
```

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

### Autodesk.Revit.DB.Electrical.AnalyticalPowerSourceData Properties

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

Properties for an analytical power source node.

```APIDOC
## Autodesk.Revit.DB.Electrical.AnalyticalPowerSourceData.TotalConnectedCurrent

### Description
The total connected current of the analytical power source.

### Method
Property Access

### Endpoint
Autodesk.Revit.DB.Electrical.AnalyticalPowerSourceData

### Parameters
None explicitly documented.

### Request Example
None explicitly documented.

### Response
None explicitly documented.
```

```APIDOC
## Autodesk.Revit.DB.Electrical.AnalyticalPowerSourceData.Voltage

### Description
The voltage value of the analytical power source.

### Method
Property Access

### Endpoint
Autodesk.Revit.DB.Electrical.AnalyticalPowerSourceData

### Parameters
None explicitly documented.

### Request Example
None explicitly documented.

### Response
None explicitly documented.
```

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

### ScheduleSheetInstance

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

Provides methods and properties for managing schedule segments on sheets.

```APIDOC
## ScheduleSheetInstance Class

### Properties
- **SegmentIndex** (int): Gets or sets the index of the schedule segment associated with this instance.

### Methods
- **Create(Document document, ElementId viewSheetId, ElementId scheduleId, XYZ origin, int segmentIndex)**: Creates a new `ScheduleSheetInstance` on a specified sheet.
  - **Parameters**:
    - `document` (Document): The current Revit document.
    - `viewSheetId` (ElementId): The ID of the sheet view.
    - `scheduleId` (ElementId): The ID of the schedule.
    - `origin` (XYZ): The insertion point for the schedule instance.
    - `segmentIndex` (int): The index of the schedule segment to place.
```

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

### DirectShapeType UserAssignability

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

Provides API-level control for the visibility and assignability of DirectShapeTypes in the Revit UI.

```APIDOC
## DirectShapeType.UserAssignability

### Description
Controls whether a DirectShapeType appears in the type selector and can be assigned to existing DirectShapes.

### Property
DirectShapeType.UserAssignability (bool)
```

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

### Equipment Load Data

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

Class and enums for representing data related to equipment load.

```APIDOC
## AnalyticalEquipmentLoadData Class

### Description
Represents the data and parameters of a point load node.

## AnalyticalEquipmentLoadData.ApparentLoad Property

### Description
Represents the electrical apparent load of the analytical equipment load.

### Method
Property

### Endpoint
AnalyticalEquipmentLoadData.ApparentLoad

## AnalyticalEquipmentLoadData.PowerFactor Property

### Description
Represents the power factor of the analytical equipment load.

### Method
Property

### Endpoint
AnalyticalEquipmentLoadData.PowerFactor

## AnalyticalEquipmentLoadData.TrueLoad Property

### Description
Represents the electrical true load of the analytical equipment load.

### Method
Property

### Endpoint
AnalyticalEquipmentLoadData.TrueLoad

## AnalyticalEquipmentLoadData.LoadClassification Property

### Description
Represents the load classification of the analytical equipment load.

### Method
Property

### Endpoint
AnalyticalEquipmentLoadData.LoadClassification

## AnalyticalEquipmentLoadData.LoadType Property

### Description
Represents the load type of the analytical equipment load.

### Method
Property

### Endpoint
AnalyticalEquipmentLoadData.LoadType

## ElectricalLoadType Enum

### Description
Represents the electrical load type.

## ElectricalAnalyticalNodeType Enum

### Description
Represents the type of electrical analytical node.
```

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

### ScheduleHeightsOnSheet

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

Provides information about the heights of schedule titles, column headers, and body rows on a sheet view.

```APIDOC
## Class: Autodesk.Revit.DB.ScheduleHeightsOnSheet

### Description
Represents the heights of schedule components on a sheet view.

### Usage
This class is returned by the `ViewSchedule.GetScheduleHeightsOnSheet()` method.
```

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

### Bounding Box API

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

Checks if the bounding box is enabled and not empty.

```APIDOC
## BoundingBoxXYZ.IsSet

### Description
Checks if the bounding box is enabled and not empty.

### Property
BoundingBoxXYZ.IsSet (bool)
```

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

### ViewSchedule.GetScheduleHeightsOnSheet()

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

Retrieves the schedule heights information for a given schedule view.

```APIDOC
## Method: ViewSchedule.GetScheduleHeightsOnSheet()

### Description
Returns an object of type `ScheduleHeightsOnSheet` which contains the heights of the schedule title, column header, and each body row on a sheet view.

### Returns
- `ScheduleHeightsOnSheet`: An object containing the height information for the schedule on a sheet.
```

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

### View Placement on Sheet

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

Enum and method for determining the placement status of a view on a sheet.

```APIDOC
## ViewPlacementOnSheetStatus Enum

### Description
Indicates whether a View is placed on a Sheet, either completely or partially.

## Viewport.GetPlacementOnSheetStatus()

### Description
Determines if this view is placed on a sheet completely or partially.

### Method
Method

### Endpoint
Viewport.GetPlacementOnSheetStatus()
```

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

### Electrical Analytical Node

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

New class and related members for representing and managing electrical analytical nodes.

```APIDOC
## ElectricalAnalyticalNode Class

### Description
Represents an electrical analytical node in the system.

## ElectricalAnalyticalNodeType Enum

### Description
Represents the type of electrical analytical node.

## ElectricalAnalyticalNode.TotalLoad Property

### Description
Represents the total connected load of the electrical analytical node.

### Method
Property

### Endpoint
ElectricalAnalyticalNode.TotalLoad

## ElectricalAnalyticalNode.CanConnectToUpstreamNode()

### Description
Verifies that the current node can connect to the upstream node.

### Method
Method

### Endpoint
ElectricalAnalyticalNode.CanConnectToUpstreamNode()

## ElectricalAnalyticalNode.CanDisconnectFromUpstreamNode()

### Description
Verifies that the current node can disconnect from the upstream node.

### Method
Method

### Endpoint
ElectricalAnalyticalNode.CanDisconnectFromUpstreamNode()

## ElectricalAnalyticalNode.ClearConnections()

### Description
Clears all existing connections for the electrical analytical node.

### Method
Method

### Endpoint
ElectricalAnalyticalNode.ClearConnections()

## ElectricalAnalyticalNode.ConnectToUpstreamNode()

### Description
Connects the current node to an upstream node.

### Method
Method

### Endpoint
ElectricalAnalyticalNode.ConnectToUpstreamNode(upstreamNodeId)

## ElectricalAnalyticalNode.Create()

### Description
Creates a new electrical analytical node.

### Method
Method

### Endpoint
ElectricalAnalyticalNode.Create()

## ElectricalAnalyticalNode.DisconnectFromUpstreamNode()

### Description
Disconnects the current node from its upstream node.

### Method
Method

### Endpoint
ElectricalAnalyticalNode.DisconnectFromUpstreamNode()

## ElectricalAnalyticalNode.GetAnalyticalPropertyData()

### Description
Retrieves the analytical property data for the electrical analytical node.

### Method
Method

### Endpoint
ElectricalAnalyticalNode.GetAnalyticalPropertyData()

## ElectricalAnalyticalNode.GetDownstreamNodeIds()

### Description
Retrieves the IDs of all downstream nodes connected to this node.

### Method
Method

### Endpoint
ElectricalAnalyticalNode.GetDownstreamNodeIds()

## ElectricalAnalyticalNode.GetUpstreamNodeIds()

### Description
Retrieves the IDs of all upstream nodes connected to this node.

### Method
Method

### Endpoint
ElectricalAnalyticalNode.GetUpstreamNodeIds()
```

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

### ShapeImporter API Additions

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

Allows importing data from additional file types including SKP, STL, and OBJ.

```APIDOC
## ShapeImporter Enumerations

### Description
Enumerations to specify file types for ShapeImporter.

### Enumerations
- **ShapeImporter.SKP**
- **ShapeImporter.STL**
- **ShapeImporter.OBJ**
```

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

### Energy Analysis API Changes - Volume Properties

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

Deprecation of InnerVolume and AnalyticalVolume properties for EnergyAnalysisSpace, with their replacement.

```APIDOC
## Energy Analysis API Changes - Volume Properties

### Description
The InnerVolume and AnalyticalVolume properties of EnergyAnalysisSpace have been deprecated and replaced by the Volume property.

### Deprecated API: EnergyAnalysisSpace.InnerVolume
- **Replacement**: EnergyAnalysisSpace.Volume

### Deprecated API: EnergyAnalysisSpace.AnalyticalVolume
- **Replacement**: EnergyAnalysisSpace.Volume
```

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

### Autodesk.Revit.DB.CurveElement.CreateAreaBasedLoadBoundaryLine

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

Creates a boundary line for an area-based load.

```APIDOC
## Autodesk.Revit.DB.CurveElement.CreateAreaBasedLoadBoundaryLine()

### Description
Creates an area based load boundary line.

### Method
Method

### Endpoint
Autodesk.Revit.DB.CurveElement

### Parameters
None explicitly documented.

### Request Example
None explicitly documented.

### Response
None explicitly documented.
```

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

### ViewSheet Duplication API

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

Allows duplicating sheets with different options for copying details and views.

```APIDOC
## ViewSheet.Duplicate(SheetDuplicateOption)

### Description
Duplicates a sheet with the specified duplication option.

### Method
ViewSheet.Duplicate(SheetDuplicateOption)

### Parameters
- **option** (SheetDuplicateOption) - The option specifying what information to copy when duplicating the sheet.
```

```APIDOC
## ViewSheet.CanBeDuplicated(SheetDuplicateOption)

### Description
Checks if a sheet can be duplicated with the specified duplication option.

### Method
ViewSheet.CanBeDuplicated(SheetDuplicateOption)

### Parameters
- **option** (SheetDuplicateOption) - The option specifying what information to copy when duplicating the sheet.

### Returns
(bool) True if the sheet can be duplicated with the given option, false otherwise.
```

```APIDOC
## SheetDuplicateOption Enum

### Description
Indicates what information should be copied when duplicating a sheet.

### Values
- **DuplicateEmptySheet**: Only copies the title block.
- **DuplicateSheetWithDetailing**: Copies the title block and details.
- **DuplicateSheetWithViewsOnly**: Copies the title block, details, viewports, and contained views. The newly created sheet will reference the newly duplicated views.
- **DuplicateSheetWithViewsAndDetailing**: Copies the title block, details, and viewports. Duplicates the sheet's contained views with detailing. The newly created sheet will reference the newly duplicated views.
- **DuplicateSheetWithViewsAsDependent**: Copies the title block, details, and viewports. Duplicates the sheet's contained views as dependent. The newly created sheet will reference the newly duplicated dependent views.
```

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

### Boundary Validation Methods

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

Methods to validate curve loop boundaries on view sketch planes and general sketch planes.

```APIDOC
## BoundaryValidation.IsValidBoundaryOnView()

### Description
Checks that a curve loop boundary is valid on the view's sketch plane.

### Method
BoundaryValidation.IsValidBoundaryOnView()

## BoundaryValidation.IsValidBoundaryOnSketchPlane()

### Description
Checks that a curve loop boundary is valid on a sketch plane.

### Method
BoundaryValidation.IsValidBoundaryOnSketchPlane()
```

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

### Schedule Segment Management

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

Methods for managing schedule segments, including splitting, deleting, and merging.

```APIDOC
## Schedule Segment Management Methods

### ViewSchedule.IsSplit()
Checks if a schedule is split into segments.

### ViewSchedule.Split(int segmentNumber)
Splits a schedule into a specified number of segments.

### ViewSchedule.Split(IList<double> segmentHeights)
Splits a schedule using a list of segment heights.

### ViewSchedule.SplitSegment()
Splits the currently selected schedule segment.

### ViewSchedule.DeleteSegment()
Deletes the currently selected schedule segment.

### ViewSchedule.MergeSegments()
Merges the currently selected schedule segments.

### ViewSchedule.GetSegmentCount()
Returns the number of segments in the schedule.

### ViewSchedule.GetSegmentHeight(int segmentIndex)
Returns the height of a specific schedule segment.

### ViewSchedule.SetSegmentHeight(int segmentIndex, double height)
Sets the height of a specific schedule segment.
```

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

### Energy Analysis API Changes - Conceptual Masses

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

Deprecation of classes and methods related to Conceptual Masses in Energy Analysis, replaced by detailed energy analysis components.

```APIDOC
## Energy Analysis API Changes - Conceptual Masses

### Description
Several classes and methods used for Conceptual Masses in Energy Analysis have been deprecated and are now replaced by components within the detailed energy analysis framework.

### Deprecated API: DB.Analysis.AnalysisMode.ConceptualMasses
- **Replacement**: ConceptualMassesAndBuildingElements

### Deprecated API: DB.Analysis.EnergyDataSettings.setCreateAnalyticalModel()
- **Replacement**: Use EnergyModel property instead.

### Deprecated API: DB.Analysis.EnergyDataSettings.enableConceptualEnergyAnalyticalModel()
- **Replacement**: Use EnergyModel property instead.

### Deprecated API: DB.Analysis.MassGBXMLExportOptions
- **Replacement**: GBXMLExportOptions

### Deprecated API: DB.Analysis.MassEnergyAnalyticalMode
- **Replacement**: EnergyAnalyticalDetailModel

### Deprecated API: DB.Analysis.MassZone
- **Replacement**: EnergyAnalyticalDetailModel and EnergyAnalysisSpace

### Deprecated API: DB.Analysis.MassLevelData
- **Replacement**: EnergyAnalyticalDetailModel EnergyAnalysisSpace

### Deprecated API: DB.Analysis.MassSurfaceData
- **Replacement**: EnergyAnalyticalDetailModel and EnergyAnalysisSurface
```

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

### Geometry API Changes - Geometry Instance

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

Deprecation of the Element Symbol property for GeometryInstance and its replacement.

```APIDOC
## Geometry API Changes - Geometry Instance

### Description
The Element Symbol property of the GeometryInstance has been deprecated and a replacement method is provided.

### Deprecated API: GeometryInstance.ElementSymbol
- **Replacement**: GeometryInstance.GetDocument().GetElement(GeometryInstance.GetSymbolGeometryId().SymbolId)
```

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

### Structure API Additions - Area Load

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

Methods for creating hosted area loads and checking host validity for area loads.

```APIDOC
## Autodesk.Revit.DB.Structure.AreaLoad.Create()

### Description
Creates a new hosted area load within the project.

### Method
Autodesk.Revit.DB.Structure.AreaLoad.Create()

## Autodesk.Revit.DB.Structure.AreaLoad.isValidHostId()

### Description
Indicates if the provided host id can host area loads.

### Method
Autodesk.Revit.DB.Structure.AreaLoad.isValidHostId()
```

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

### Bus Data API

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

Class and methods for representing and retrieving data for analytical bus nodes.

```APIDOC
## AnalyticalBusData Class

### Description
Represents the data and parameters of an analytical bus node.

## AnalyticalBusData.Rating Property

### Description
Represents the rating value of the analytical bus.

### Method
Property

### Endpoint
AnalyticalBusData.Rating

## AnalyticalBusData.Voltage Property

### Description
Represents the voltage value of the analytical bus.

### Method
Property

### Endpoint
AnalyticalBusData.Voltage

## AnalyticalBusData.GetTotalCurrent()

### Description
Gets the total connected current for the analytical bus.

### Method
Method

### Endpoint
AnalyticalBusData.GetTotalCurrent()
```

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

### Area Based Load Type

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

Class and method for creating and managing area-based load types.

```APIDOC
## AreaBasedLoadType Class

### Description
Represents an area-based load type in Autodesk Revit.

## AreaBasedLoadType.ApparentPowerDensity Property

### Description
Represents the apparent power density of an area-based load type.

### Method
Property

### Endpoint
AreaBasedLoadType.ApparentPowerDensity

## AreaBasedLoadType.LoadClassification Property

### Description
Represents the load classification of an area-based load type.

### Method
Property

### Endpoint
AreaBasedLoadType.LoadClassification

## AreaBasedLoadType.LoadDensity Property

### Description
Represents the load density of an area-based load type.

### Method
Property

### Endpoint
AreaBasedLoadType.LoadDensity

## AreaBasedLoadType.PowerFactor Property

### Description
Represents the power factor of an area-based load type.

### Method
Property

### Endpoint
AreaBasedLoadType.PowerFactor

## AreaBasedLoadType.Create()

### Description
Creates a new area-based load type.

### Method
Method

### Endpoint
AreaBasedLoadType.Create()
```

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

### Distribution Node Property Data

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

Class representing data and parameters for electrical analytical nodes.

```APIDOC
## AnalyticalDistributionNodePropertyData Class

### Description
Represents the data and parameters of an electrical analytical node.

## AnalyticalDistributionNodePropertyData.NumberOfPoles Property

### Description
Represents the number of poles for the distribution node.

### Method
Property

### Endpoint
AnalyticalDistributionNodePropertyData.NumberOfPoles
```

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

### Delete Workset API

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

Supports deleting worksets from the model. It takes a DeleteWorksetSettings input with options for handling contained elements.

```APIDOC
## WorksetTable.DeleteWorkset()

### Description
Deletes a workset from the model, with options for handling its contained elements.

### Method
WorksetTable.DeleteWorkset()

### Parameters
- **settings** (DeleteWorksetSettings) - Options for deleting the workset and its elements.
```

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

### Panel Schedule Slot Locking

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

Method to set the lock state for a circuit slot in a panel schedule.

```APIDOC
## PanelScheduleView.SetLockSlot()

### Description
Allows an application to set the lock state for a circuit slot at a specific cell within a panel schedule.

### Method
Method

### Endpoint
PanelScheduleView.SetLockSlot(cell, lockState)
```

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

### Custom Export API Changes

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

Deprecation of GroupNode methods and their replacements.

```APIDOC
## Custom Export API Changes

### Description
This section details the deprecation of methods related to GroupNode, which is the base class for InstanceNode and LinkNode, and provides their replacements.

### Deprecated API: GroupNode.GetSymbolId()
- **Replacement for LinkNode**: LinkNode.SymbolId
- **Replacement for InstanceNode**: InstanceNode.GetSymbolGeometryId()
```

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

### Export API Changes - STLExportResolution

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

Deprecation of STLExportResolution enum and related methods, with their replacements.

```APIDOC
## Export API Changes - STLExportResolution

### Description
The STLExportResolution enum and associated methods in STLExportOptions have been deprecated and replaced with ExportResolution.

### Deprecated API: STLExportResolution enum
- **Replacement**: ExportResolution enum

### Deprecated API: STLExportOptions(STLExportResolution)
- **Replacement**: STLExportOptions(ExportResolution)

### Deprecated API: STLExportOptions.SetTessellationSettings(STLExportResolution)
- **Replacement**: STLExportOptions.SetTessellationSettings(ExportResolution)
```

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

### Energy Analysis API Changes - Area Property

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

Modification of the EnergyAnalysisSpace.Area property to cover more scenarios.

```APIDOC
## Energy Analysis API Changes - Area Property

### Description
The Autodesk.Revit.DB.Analysis.EnergyAnalysisSpace.Area property has been modified to encompass all scenarios, including spaces created with modes other than 'Use Rooms or Spaces'.

### Modified API: Autodesk.Revit.DB.Analysis.EnergyAnalysisSpace.Area
- **Update**: Now covers spaces created with 'Use Building Elements' and 'Use Conceptual Masses and Building Elements', measuring area by the center plane of walls and the top plane of roofs and floors, in addition to the previously supported 'Use Rooms or Spaces' mode.
```

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

### Electrical Load Classification

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

Read-only property to indicate if a load classification is for spare usage.

```APIDOC
## ElectricalLoadClassification.Spare Property

### Description
Indicates if this load classification is to be used for spare purposes.

### Method
Property (Read-only)

### Endpoint
ElectricalLoadClassification.Spare
```

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

### ScheduleDefinition.IsFilteredBySheet

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

Indicates whether a schedule definition is filtered by sheet.

```APIDOC
## Property: ScheduleDefinition.IsFilteredBySheet

### Description
Gets a boolean value indicating if the schedule is set to filter its content by sheet.

### Returns
- `bool`: `true` if the schedule is filtered by sheet, `false` otherwise.
```

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

### ScheduleDefinition.IsValidCategoryForFilterBySheet()

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

Checks if the current category of a schedule definition is valid for filtering by sheet.

```APIDOC
## Method: ScheduleDefinition.IsValidCategoryForFilterBySheet()

### Description
Determines whether the category associated with this `ScheduleDefinition` can be filtered by sheet.

### Returns
- `bool`: `true` if the category is valid for filtering by sheet, `false` otherwise.
```

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

### SymbolGeometryId API

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

Used to identify geometry managed by a symbol element and compare geometry instances.

```APIDOC
## SymbolGeometryId.AsUniqueIdentifier()

### Description
Converts the SymbolGeometryId to a string for comparison to identify if two instances point to the same geometry managed by the same symbol element.

### Method
SymbolGeometryId.AsUniqueIdentifier()

### Returns
(string) A unique identifier for the geometry.
```

```APIDOC
## SymbolGeometryId.SymbolId

### Description
Gets the ID of the symbol that contains the shared geometry.

### Property
SymbolGeometryId.SymbolId (SymbolId)
```

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

### Structure API Additions - RebarCoupler

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

Property to identify the rotation angle of a rebar coupler around its axis.

```APIDOC
## RebarCoupler.RotationAngle

### Description
Identifies the rotation angle of the coupler around its axis.

### Property
RebarCoupler.RotationAngle (double)
```
Tokens:
Raw