2027 Class
Changes 0
C

AnalysisDisplayLegendSettings

Description:
Contains legend settings for analysis display style element.
Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.Analysis.AnalysisDisplayLegendSettings
public class AnalysisDisplayLegendSettings : IDisposable
AnalysisDisplayLegendSettings legendSettings = new AnalysisDisplayLegendSettings();
legendSettings.NumberOfSteps = 10;
legendSettings.Rounding = 0.05;
legendSettings.ShowDataDescription = false;
legendSettings.ShowLegend = true;
Name Return Type Description Inherited From
C AnalysisDisplayLegendSettings() None Constructs a default instance of legend settings.
C AnalysisDisplayLegendSettings(AnalysisDisplayLegendSettings) None Constructs a new copy of the input AnalysisDisplayLegendSettings object.
Name Return Type Description Inherited From
M Dispose() None Releases all resources used by the AnalysisDisplayLegendSettings
M Equals None Determines whether the specified object is equal to the current object. (Inherited from Object ) Object
M GetHashCode None Serves as the default hash function. (Inherited from Object ) Object
M GetType None Gets the Type of the current instance. (Inherited from Object ) Object
M IsEqual(AnalysisDisplayLegendSettings) Boolean Compares two legend settings objects.
M ToString None Returns a string that represents the current object. (Inherited from Object ) Object
Name Return Type Description Inherited From
P ColorRangeHeight int Height of color range (for Colored Surface, Markers and Text, and Vector display). Measured in paperspace units.
P ColorRangeWidth int Width of color range (for Colored Surface, Markers and Text, and Vector display). Measured in paperspace units.
P HeadingTextTypeId ElementId Element id of text associated with legend heading.
P IsValidObject Boolean Specifies whether the .NET object represents a valid Revit entity.
P NumberForScale double A fixed value to display on the legend scale (0 by default; 0 means width of legend scale is calculated dynamically).
P NumberOfSteps int Number of steps (values between minimum and maximum) to be shown in legend.
P Rounding double Rounding increment for numeric values of analysis results.
P ScaleHeight int Height of scale (for Diagram display). Measured in paperspace units.
P ShowDataDescription bool If true, data description is shown in the legend.
P ShowDataName bool If true, data name is shown in the legend.
P ShowLegend bool If true, legend is shown in the view.
P ShowUnits bool If true, units are shown in the legend.
P TextTypeId ElementId Element id of text associated with legend body.