AnalysisDisplayLegendSettings

Public Class

Contains legend settings for analysis display style element.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.Analysis.AnalysisDisplayLegendSettings

Namespace: Autodesk.Revit.DB.Analysis

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class AnalysisDisplayLegendSettings : IDisposable

The AnalysisDisplayLegendSettings type exposes the following members.

Constructors

Name

Description

---

Public Method
AnalysisDisplayLegendSettings.

Constructs a default instance of legend settings.

---

Public Method
AnalysisDisplayLegendSettings(AnalysisDisplayLegendSettings)

Constructs a new copy of the input AnalysisDisplayLegendSettings object.

---

Properties

Name

Description

---

Public Property

ColorRangeHeight

Height of color range (for Colored Surface, Markers and Text, and Vector display). Measured in paperspace units.

---

Public Property

ColorRangeWidth

Width of color range (for Colored Surface, Markers and Text, and Vector display). Measured in paperspace units.

---

Public Property

HeadingTextTypeId

Element id of text associated with legend heading.

---

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.

---

Public Property

NumberForScale

A fixed value to display on the legend scale (0 by default; 0 means width of legend scale is calculated dynamically).

---

Public Property

NumberOfSteps

Number of steps (values between minimum and maximum) to be shown in legend.

---

Public Property

Rounding

Rounding increment for numeric values of analysis results.

---

Public Property

ScaleHeight

Height of scale (for Diagram display). Measured in paperspace units.

---

Public Property

ShowDataDescription

If true, data description is shown in the legend.

---

Public Property

ShowDataName

If true, data name is shown in the legend.

---

Public Property

ShowLegend

If true, legend is shown in the view.

---

Public Property

ShowUnits

If true, units are shown in the legend.

---

Public Property

TextTypeId

Element id of text associated with legend body.

---

Methods

Name

Description

---

Public Method

Dispose

Releases all resources used by the AnalysisDisplayLegendSettings

---

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

---

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

---

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

---

Public Method

IsEqual

Compares two legend settings objects.

---

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

---

Example

AnalysisDisplayLegendSettings legendSettings = new AnalysisDisplayLegendSettings();
legendSettings.NumberOfSteps = 10;
legendSettings.Rounding = 0.05;
legendSettings.ShowDataDescription = false;
legendSettings.ShowLegend = true;