GeoBlazor Pro


layout: pro title: AuthoringInfo parent: Pro Classes grand_parent: GeoBlazor Pro —

dymaptic.GeoBlazor.Pro

dymaptic.GeoBlazor.Pro.Objects

AuthoringInfo Class

Authoring information related to generating renderers and visual variables with the Smart Mapping methods. This includes information from UI elements such as sliders and selected classification methods and themes. This allows the authoring clients to save settings so that their selections can be remembered.
ArcGIS Maps SDK for JavaScript

public class AuthoringInfo :
System.IEquatable<dymaptic.GeoBlazor.Pro.Objects.AuthoringInfo>

Inheritance System.Object 🡒 AuthoringInfo

Implements System.IEquatable<AuthoringInfo>

Constructors

AuthoringInfo(string, ColorRamp, double, AuthoringInfoField, AuthoringInfoField, IReadOnlyCollection, string, string, bool, string, double, double, int, double, AuthoringInfoStatistics, string, string, string, IReadOnlyCollection) Constructor

Authoring information related to generating renderers and visual variables with the Smart Mapping methods. This includes information from UI elements such as sliders and selected classification methods and themes. This allows the authoring clients to save settings so that their selections can be remembered.
ArcGIS Maps SDK for JavaScript

public AuthoringInfo(string ClassificationMethod, dymaptic.GeoBlazor.Core.Components.Renderers.ColorRamps.ColorRamp ColorRamp, double FadeRatio, dymaptic.GeoBlazor.Pro.Objects.AuthoringInfoField Field1, dymaptic.GeoBlazor.Pro.Objects.AuthoringInfoField Field2, System.Collections.Generic.IReadOnlyCollection<string> Fields, string FlowTheme, string Focus, bool IsAutoGenerated, string LengthUnit, double MaxSliderValue, double MinSliderValue, int NumClasses, double StandardDeviationInterval, dymaptic.GeoBlazor.Pro.Objects.AuthoringInfoStatistics Statistics, string Type, string UnivariateSymbolStyle, string UnivariateTheme, System.Collections.Generic.IReadOnlyCollection<dymaptic.GeoBlazor.Pro.Objects.AuthoringInfoVisualVariable> VisualVariables);

Parameters

ClassificationMethod System.String

Indicates which classification method was used if a classed color or classed size renderer was generated using one of the Smart Mapping functions.

ColorRamp dymaptic.GeoBlazor.Core.Components.Renderers.ColorRamps.ColorRamp

Indicates the color ramp was used to create the symbols for Unique Value or Class Breaks renderer for Imagery Layer.

FadeRatio System.Double

Only applicable to HeatmapRenderer created with the heatmap renderer creator. Indicates how much the user opted to fade the edges of the heatmap to transparent.

Field1 AuthoringInfoField

A numeric field used for generating a relationship renderer along with field2. In the default visualization, the values of this field are rendered along the vertical axis of the Legend.

Field2 AuthoringInfoField

A numeric field used for generating a relationship renderer along with field1. In the default visualization, the values of this field are rendered along the horizontal axis of the Legend.

Fields System.Collections.Generic.IReadOnlyCollection<System.String>

An array of string values representing field names used for creating a predominance renderer.

FlowTheme System.String

Only applicable to flow renderers. Indicates the user-selected theme of the generated renderer.

Focus System.String

The focus of a relationship renderer. This determines the orientation of the legend.

IsAutoGenerated System.Boolean

Indicates whether the renderer was created internally by the JS API’s rendering engine for default FeatureReductionCluster visualizations. You should avoid setting or changing this value.
Default Value:false

LengthUnit System.String

Only applicable to renderer used in web scenes. Indicates the unit used in real-world sizes.

MaxSliderValue System.Double

Indicates the value of the upper handle if a slider was used to generate the dot value for dot density renderer.

MinSliderValue System.Double

Indicates the value of the lower handle if a slider was used to generate the dot value for dot density renderer.

NumClasses System.Int32

The number of classes used to classify each field of a relationship renderer. This determines the number of categories in the legend.

StandardDeviationInterval System.Double

Indicates the standard deviation interval for each stop in a classed color or classed size renderer that was generated using the standard-deviation classification method.
Possible Values: 0.25 | 0.33 | 0.5 | 1

Statistics AuthoringInfoStatistics

Only for renderers of type univariate-color-size with an above-and-below univariateTheme. Contains summary statistics about the data represented by the renderer. The Legend can use this information to avoid displaying values beyond the min and max data values of the layer.

Type System.String

Indicates the renderer type generated from one of the Smart Mapping functions.

UnivariateSymbolStyle System.String

Only applicable to univariateColorSize renderers with an above-and-below univariateTheme. Indicates if the above and below renderer uses a predefined symbol pair provided by the API.
The custom style indicates the renderer was authored with custom symbols not provided as a predefined symbol pair in the renderer creator.

UnivariateTheme System.String

Only applicable to univariateColorSize renderers. Indicates the theme of the univariate color and size renderer.

VisualVariables System.Collections.Generic.IReadOnlyCollection<AuthoringInfoVisualVariable>

Contains authoring properties of visual variables generated from one of the Smart Mapping methods or sliders.

Properties

AuthoringInfo.ClassificationMethod Property

Indicates which classification method was used if a classed color or classed size renderer was generated using one of the Smart Mapping functions.

public string ClassificationMethod { get; set; }

Property Value

System.String

AuthoringInfo.ColorRamp Property

Indicates the color ramp was used to create the symbols for Unique Value or Class Breaks renderer for Imagery Layer.

public dymaptic.GeoBlazor.Core.Components.Renderers.ColorRamps.ColorRamp ColorRamp { get; set; }

Property Value

dymaptic.GeoBlazor.Core.Components.Renderers.ColorRamps.ColorRamp

AuthoringInfo.FadeRatio Property

Only applicable to HeatmapRenderer created with the heatmap renderer creator. Indicates how much the user opted to fade the edges of the heatmap to transparent.

public double FadeRatio { get; set; }

Property Value

System.Double

AuthoringInfo.Field1 Property

A numeric field used for generating a relationship renderer along with field2. In the default visualization, the values of this field are rendered along the vertical axis of the Legend.

public dymaptic.GeoBlazor.Pro.Objects.AuthoringInfoField Field1 { get; set; }

Property Value

AuthoringInfoField

AuthoringInfo.Field2 Property

A numeric field used for generating a relationship renderer along with field1. In the default visualization, the values of this field are rendered along the horizontal axis of the Legend.

public dymaptic.GeoBlazor.Pro.Objects.AuthoringInfoField Field2 { get; set; }

Property Value

AuthoringInfoField

AuthoringInfo.Fields Property

An array of string values representing field names used for creating a predominance renderer.

public System.Collections.Generic.IReadOnlyCollection<string> Fields { get; set; }

Property Value

System.Collections.Generic.IReadOnlyCollection<System.String>

AuthoringInfo.FlowTheme Property

Only applicable to flow renderers. Indicates the user-selected theme of the generated renderer.

public string FlowTheme { get; set; }

Property Value

System.String

AuthoringInfo.Focus Property

The focus of a relationship renderer. This determines the orientation of the legend.

public string Focus { get; set; }

Property Value

System.String

AuthoringInfo.IsAutoGenerated Property

Indicates whether the renderer was created internally by the JS API’s rendering engine for default FeatureReductionCluster visualizations. You should avoid setting or changing this value.
Default Value:false

public bool IsAutoGenerated { get; set; }

Property Value

System.Boolean

AuthoringInfo.LengthUnit Property

Only applicable to renderer used in web scenes. Indicates the unit used in real-world sizes.

public string LengthUnit { get; set; }

Property Value

System.String

AuthoringInfo.MaxSliderValue Property

Indicates the value of the upper handle if a slider was used to generate the dot value for dot density renderer.

public double MaxSliderValue { get; set; }

Property Value

System.Double

AuthoringInfo.MinSliderValue Property

Indicates the value of the lower handle if a slider was used to generate the dot value for dot density renderer.

public double MinSliderValue { get; set; }

Property Value

System.Double

AuthoringInfo.NumClasses Property

The number of classes used to classify each field of a relationship renderer. This determines the number of categories in the legend.

public int NumClasses { get; set; }

Property Value

System.Int32

AuthoringInfo.StandardDeviationInterval Property

Indicates the standard deviation interval for each stop in a classed color or classed size renderer that was generated using the standard-deviation classification method.
Possible Values: 0.25 | 0.33 | 0.5 | 1

public double StandardDeviationInterval { get; set; }

Property Value

System.Double

AuthoringInfo.Statistics Property

Only for renderers of type univariate-color-size with an above-and-below univariateTheme. Contains summary statistics about the data represented by the renderer. The Legend can use this information to avoid displaying values beyond the min and max data values of the layer.

public dymaptic.GeoBlazor.Pro.Objects.AuthoringInfoStatistics Statistics { get; set; }

Property Value

AuthoringInfoStatistics

AuthoringInfo.Type Property

Indicates the renderer type generated from one of the Smart Mapping functions.

public string Type { get; set; }

Property Value

System.String

AuthoringInfo.UnivariateSymbolStyle Property

Only applicable to univariateColorSize renderers with an above-and-below univariateTheme. Indicates if the above and below renderer uses a predefined symbol pair provided by the API.
The custom style indicates the renderer was authored with custom symbols not provided as a predefined symbol pair in the renderer creator.

public string UnivariateSymbolStyle { get; set; }

Property Value

System.String

AuthoringInfo.UnivariateTheme Property

Only applicable to univariateColorSize renderers. Indicates the theme of the univariate color and size renderer.

public string UnivariateTheme { get; set; }

Property Value

System.String

AuthoringInfo.VisualVariables Property

Contains authoring properties of visual variables generated from one of the Smart Mapping methods or sliders.

public System.Collections.Generic.IReadOnlyCollection<dymaptic.GeoBlazor.Pro.Objects.AuthoringInfoVisualVariable> VisualVariables { get; set; }

Property Value

System.Collections.Generic.IReadOnlyCollection<AuthoringInfoVisualVariable>