AnalysisDisplayLegendSettings Class

Contains legend settings for analysis display style element.
Inheritance Hierarchy
SystemObject
  Autodesk.Revit.DB.AnalysisAnalysisDisplayLegendSettings

Namespace: Autodesk.Revit.DB.Analysis
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntax
Copy
public class AnalysisDisplayLegendSettings : IDisposable

The AnalysisDisplayLegendSettings type exposes the following members.

Constructors
 NameDescription
Public methodAnalysisDisplayLegendSettings Constructs a default instance of legend settings.
Public methodAnalysisDisplayLegendSettings(AnalysisDisplayLegendSettings) Constructs a new copy of the input AnalysisDisplayLegendSettings object.
Top
Properties
 NameDescription
Public propertyColorRangeHeight Height of color range (for Colored Surface, Markers and Text, and Vector display). Measured in paperspace units.
Public propertyColorRangeWidth Width of color range (for Colored Surface, Markers and Text, and Vector display). Measured in paperspace units.
Public propertyHeadingTextTypeId Element id of text associated with legend heading.
Public propertyIsValidObject Specifies whether the .NET object represents a valid Revit entity.
Public propertyNumberForScale A fixed value to display on the legend scale (0 by default; 0 means width of legend scale is calculated dynamically).
Public propertyNumberOfSteps Number of steps (values between minimum and maximum) to be shown in legend.
Public propertyRounding Rounding increment for numeric values of analysis results.
Public propertyScaleHeight Height of scale (for Diagram display). Measured in paperspace units.
Public propertyShowDataDescription If true, data description is shown in the legend.
Public propertyShowDataName If true, data name is shown in the legend.
Public propertyShowLegend If true, legend is shown in the view.
Public propertyShowUnits If true, units are shown in the legend.
Public propertyTextTypeId Element id of text associated with legend body.
Top
Methods
 NameDescription
Public methodDisposeReleases all resources used by the AnalysisDisplayLegendSettings
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIsEqual Compares two legend settings objects.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Example
Copy
AnalysisDisplayLegendSettings legendSettings = new AnalysisDisplayLegendSettings();
legendSettings.NumberOfSteps = 10;
legendSettings.Rounding = 0.05;
legendSettings.ShowDataDescription = false;
legendSettings.ShowLegend = true;
See Also