dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components

AuthoringInfo Class

Authoring information related to generating renderers
and visual variables with the Smart Mapping methods.
ArcGIS Maps SDK for JavaScript

public class AuthoringInfo : dymaptic.GeoBlazor.Core.Components.MapComponent

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 AuthoringInfo

Constructors

AuthoringInfo() Constructor

Parameterless constructor for use as a Razor Component.

public AuthoringInfo();

AuthoringInfo(Nullable, ColorRamp, Nullable, AuthoringInfoField, AuthoringInfoField, IReadOnlyList, Nullable, string, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, AuthoringInfoStatistics, Nullable, Nullable, IReadOnlyList) Constructor

Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.

public AuthoringInfo(System.Nullable<dymaptic.GeoBlazor.Core.Enums.ClassificationMethod> classificationMethod=null, dymaptic.GeoBlazor.Core.Components.ColorRamp? colorRamp=null, System.Nullable<double> fadeRatio=null, dymaptic.GeoBlazor.Core.Components.AuthoringInfoField? field1=null, dymaptic.GeoBlazor.Core.Components.AuthoringInfoField? field2=null, System.Collections.Generic.IReadOnlyList<string>? fields=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.AuthoringInfoFlowTheme> flowTheme=null, string? focus=null, System.Nullable<bool> isAutoGenerated=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.LengthUnit> lengthUnit=null, System.Nullable<double> maxSliderValue=null, System.Nullable<double> minSliderValue=null, System.Nullable<double> numClasses=null, System.Nullable<double> standardDeviationInterval=null, dymaptic.GeoBlazor.Core.Components.AuthoringInfoStatistics? statistics=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.UnivariateSymbolStyle> univariateSymbolStyle=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.UnivariateTheme> univariateTheme=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.AuthoringInfoVisualVariable>? visualVariables=null);

Parameters

classificationMethod System.Nullable<ClassificationMethod>

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

colorRamp ColorRamp

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

fadeRatio System.Nullable<System.Double>

Only applicable to HeatmapRenderer
created with the heatmap renderer creator.
ArcGIS Maps SDK for JavaScript

field1 AuthoringInfoField

A numeric field used for generating a relationship renderer
along with field2.
ArcGIS Maps SDK for JavaScript

field2 AuthoringInfoField

A numeric field used for generating a relationship renderer
along with field1.
ArcGIS Maps SDK for JavaScript

fields System.Collections.Generic.IReadOnlyList<System.String>

An array of string values representing field names used for creating a predominance renderer.
ArcGIS Maps SDK for JavaScript

flowTheme System.Nullable<AuthoringInfoFlowTheme>

Only applicable to flow renderers.
ArcGIS Maps SDK for JavaScript

focus System.String

The focus of a relationship renderer.
ArcGIS Maps SDK for JavaScript

isAutoGenerated System.Nullable<System.Boolean>

Indicates whether the renderer was created internally by the JS API’s rendering engine for
default FeatureReductionCluster visualizations.
default false
ArcGIS Maps SDK for JavaScript

lengthUnit System.Nullable<LengthUnit>

*Only applicable to renderer used in web scenes.Indicates the unit used in real-world sizes.
ArcGIS Maps SDK for JavaScript

maxSliderValue System.Nullable<System.Double>

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

minSliderValue System.Nullable<System.Double>

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

numClasses System.Nullable<System.Double>

The number of classes used to classify each field of a relationship renderer.
ArcGIS Maps SDK for JavaScript

standardDeviationInterval System.Nullable<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.
ArcGIS Maps SDK for JavaScript

statistics AuthoringInfoStatistics

Only for renderers of type univariate-color-size with an above-and-below univariateTheme.
ArcGIS Maps SDK for JavaScript

univariateSymbolStyle System.Nullable<UnivariateSymbolStyle>

Only applicable to univariateColorSize renderers with an above-and-below univariateTheme.
ArcGIS Maps SDK for JavaScript

univariateTheme System.Nullable<UnivariateTheme>

Only applicable to univariateColorSize renderers.
ArcGIS Maps SDK for JavaScript

visualVariables System.Collections.Generic.IReadOnlyList<AuthoringInfoVisualVariable>

Contains authoring properties of visual variables generated from
one of the Smart Mapping methods or sliders.
ArcGIS Maps SDK for JavaScript

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.
ArcGIS Maps SDK for JavaScript

public System.Nullable<dymaptic.GeoBlazor.Core.Enums.ClassificationMethod> ClassificationMethod { get; set; }

Property Value

System.Nullable<ClassificationMethod>

AuthoringInfo.ColorRamp Property

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

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

Property Value

ColorRamp

AuthoringInfo.FadeRatio Property

Only applicable to HeatmapRenderer
created with the heatmap renderer creator.
ArcGIS Maps SDK for JavaScript

public System.Nullable<double> FadeRatio { get; set; }

Property Value

System.Nullable<System.Double>

AuthoringInfo.Field1 Property

A numeric field used for generating a relationship renderer
along with field2.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.AuthoringInfoField? Field1 { get; set; }

Property Value

AuthoringInfoField

AuthoringInfo.Field2 Property

A numeric field used for generating a relationship renderer
along with field1.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.AuthoringInfoField? Field2 { get; set; }

Property Value

AuthoringInfoField

AuthoringInfo.Fields Property

An array of string values representing field names used for creating a predominance renderer.
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Collections.Generic.IReadOnlyList<System.String>

AuthoringInfo.FlowTheme Property

Only applicable to flow renderers.
ArcGIS Maps SDK for JavaScript

public System.Nullable<dymaptic.GeoBlazor.Core.Enums.AuthoringInfoFlowTheme> FlowTheme { get; set; }

Property Value

System.Nullable<AuthoringInfoFlowTheme>

AuthoringInfo.Focus Property

The focus of a relationship renderer.
ArcGIS Maps SDK for JavaScript

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.
default false
ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> IsAutoGenerated { get; set; }

Property Value

System.Nullable<System.Boolean>

AuthoringInfo.LengthUnit Property

*Only applicable to renderer used in web scenes.Indicates the unit used in real-world sizes.
ArcGIS Maps SDK for JavaScript

public System.Nullable<dymaptic.GeoBlazor.Core.Enums.LengthUnit> LengthUnit { get; set; }

Property Value

System.Nullable<LengthUnit>

AuthoringInfo.MaxSliderValue Property

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

public System.Nullable<double> MaxSliderValue { get; set; }

Property Value

System.Nullable<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.
ArcGIS Maps SDK for JavaScript

public System.Nullable<double> MinSliderValue { get; set; }

Property Value

System.Nullable<System.Double>

AuthoringInfo.NumClasses Property

The number of classes used to classify each field of a relationship renderer.
ArcGIS Maps SDK for JavaScript

public System.Nullable<double> NumClasses { get; set; }

Property Value

System.Nullable<System.Double>

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.
ArcGIS Maps SDK for JavaScript

public System.Nullable<double> StandardDeviationInterval { get; set; }

Property Value

System.Nullable<System.Double>

AuthoringInfo.Statistics Property

Only for renderers of type univariate-color-size with an above-and-below univariateTheme.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.AuthoringInfoStatistics? Statistics { get; set; }

Property Value

AuthoringInfoStatistics

AuthoringInfo.UnivariateSymbolStyle Property

Only applicable to univariateColorSize renderers with an above-and-below univariateTheme.
ArcGIS Maps SDK for JavaScript

public System.Nullable<dymaptic.GeoBlazor.Core.Enums.UnivariateSymbolStyle> UnivariateSymbolStyle { get; set; }

Property Value

System.Nullable<UnivariateSymbolStyle>

AuthoringInfo.UnivariateTheme Property

Only applicable to univariateColorSize renderers.
ArcGIS Maps SDK for JavaScript

public System.Nullable<dymaptic.GeoBlazor.Core.Enums.UnivariateTheme> UnivariateTheme { get; set; }

Property Value

System.Nullable<UnivariateTheme>

AuthoringInfo.VisualVariables Property

Contains authoring properties of visual variables generated from
one of the Smart Mapping methods or sliders.
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.AuthoringInfoVisualVariable>? VisualVariables { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<AuthoringInfoVisualVariable>

Methods

AuthoringInfo.AddToFields(string[]) Method

Asynchronously adds elements to the Fields property.

public System.Threading.Tasks.Task AddToFields(params string[] values);

Parameters

values System.String[]

The elements to add.

Returns

System.Threading.Tasks.Task

AuthoringInfo.AddToVisualVariables(AuthoringInfoVisualVariable[]) Method

Asynchronously adds elements to the VisualVariables property.

public System.Threading.Tasks.Task AddToVisualVariables(params dymaptic.GeoBlazor.Core.Components.AuthoringInfoVisualVariable[] values);

Parameters

values AuthoringInfoVisualVariable[]

The elements to add.

Returns

System.Threading.Tasks.Task

AuthoringInfo.GetClassificationMethod() Method

Asynchronously retrieve the current value of the ClassificationMethod property.

public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.ClassificationMethod>> GetClassificationMethod();

Returns

System.Threading.Tasks.Task<System.Nullable<ClassificationMethod>>

AuthoringInfo.GetColorRamp() Method

Asynchronously retrieve the current value of the ColorRamp property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.ColorRamp?> GetColorRamp();

Returns

System.Threading.Tasks.Task<ColorRamp>

AuthoringInfo.GetFadeRatio() Method

Asynchronously retrieve the current value of the FadeRatio property.

public System.Threading.Tasks.Task<System.Nullable<double>> GetFadeRatio();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Double>>

AuthoringInfo.GetField1() Method

Asynchronously retrieve the current value of the Field1 property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.AuthoringInfoField?> GetField1();

Returns

System.Threading.Tasks.Task<AuthoringInfoField>

AuthoringInfo.GetField2() Method

Asynchronously retrieve the current value of the Field2 property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.AuthoringInfoField?> GetField2();

Returns

System.Threading.Tasks.Task<AuthoringInfoField>

AuthoringInfo.GetFields() Method

Asynchronously retrieve the current value of the Fields property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<string>?> GetFields();

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<System.String>>

AuthoringInfo.GetFlowTheme() Method

Asynchronously retrieve the current value of the FlowTheme property.

public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.AuthoringInfoFlowTheme>> GetFlowTheme();

Returns

System.Threading.Tasks.Task<System.Nullable<AuthoringInfoFlowTheme>>

AuthoringInfo.GetFocus() Method

Asynchronously retrieve the current value of the Focus property.

public System.Threading.Tasks.Task<string?> GetFocus();

Returns

System.Threading.Tasks.Task<System.String>

AuthoringInfo.GetIsAutoGenerated() Method

Asynchronously retrieve the current value of the IsAutoGenerated property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetIsAutoGenerated();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

AuthoringInfo.GetLengthUnit() Method

Asynchronously retrieve the current value of the LengthUnit property.

public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.LengthUnit>> GetLengthUnit();

Returns

System.Threading.Tasks.Task<System.Nullable<LengthUnit>>

AuthoringInfo.GetMaxSliderValue() Method

Asynchronously retrieve the current value of the MaxSliderValue property.

public System.Threading.Tasks.Task<System.Nullable<double>> GetMaxSliderValue();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Double>>

AuthoringInfo.GetMinSliderValue() Method

Asynchronously retrieve the current value of the MinSliderValue property.

public System.Threading.Tasks.Task<System.Nullable<double>> GetMinSliderValue();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Double>>

AuthoringInfo.GetNumClasses() Method

Asynchronously retrieve the current value of the NumClasses property.

public System.Threading.Tasks.Task<System.Nullable<double>> GetNumClasses();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Double>>

AuthoringInfo.GetStandardDeviationInterval() Method

Asynchronously retrieve the current value of the StandardDeviationInterval property.

public System.Threading.Tasks.Task<System.Nullable<double>> GetStandardDeviationInterval();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Double>>

AuthoringInfo.GetStatistics() Method

Asynchronously retrieve the current value of the Statistics property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.AuthoringInfoStatistics?> GetStatistics();

Returns

System.Threading.Tasks.Task<AuthoringInfoStatistics>

AuthoringInfo.GetUnivariateSymbolStyle() Method

Asynchronously retrieve the current value of the UnivariateSymbolStyle property.

public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.UnivariateSymbolStyle>> GetUnivariateSymbolStyle();

Returns

System.Threading.Tasks.Task<System.Nullable<UnivariateSymbolStyle>>

AuthoringInfo.GetUnivariateTheme() Method

Asynchronously retrieve the current value of the UnivariateTheme property.

public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.UnivariateTheme>> GetUnivariateTheme();

Returns

System.Threading.Tasks.Task<System.Nullable<UnivariateTheme>>

AuthoringInfo.GetVisualVariables() Method

Asynchronously retrieve the current value of the VisualVariables property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.AuthoringInfoVisualVariable>?> GetVisualVariables();

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<AuthoringInfoVisualVariable>>

AuthoringInfo.RemoveFromFields(string[]) Method

Asynchronously remove an element from the Fields property.

public System.Threading.Tasks.Task RemoveFromFields(params string[] values);

Parameters

values System.String[]

The elements to remove.

Returns

System.Threading.Tasks.Task

AuthoringInfo.RemoveFromVisualVariables(AuthoringInfoVisualVariable[]) Method

Asynchronously remove an element from the VisualVariables property.

public System.Threading.Tasks.Task RemoveFromVisualVariables(params dymaptic.GeoBlazor.Core.Components.AuthoringInfoVisualVariable[] values);

Parameters

values AuthoringInfoVisualVariable[]

The elements to remove.

Returns

System.Threading.Tasks.Task

AuthoringInfo.SetClassificationMethod(Nullable) Method

Asynchronously set the value of the ClassificationMethod property after render.

public System.Threading.Tasks.Task SetClassificationMethod(System.Nullable<dymaptic.GeoBlazor.Core.Enums.ClassificationMethod> value);

Parameters

value System.Nullable<ClassificationMethod>

The value to set.

Returns

System.Threading.Tasks.Task

AuthoringInfo.SetColorRamp(ColorRamp) Method

Asynchronously set the value of the ColorRamp property after render.

public System.Threading.Tasks.Task SetColorRamp(dymaptic.GeoBlazor.Core.Components.ColorRamp? value);

Parameters

value ColorRamp

The value to set.

Returns

System.Threading.Tasks.Task

AuthoringInfo.SetFadeRatio(Nullable) Method

Asynchronously set the value of the FadeRatio property after render.

public System.Threading.Tasks.Task SetFadeRatio(System.Nullable<double> value);

Parameters

value System.Nullable<System.Double>

The value to set.

Returns

System.Threading.Tasks.Task

AuthoringInfo.SetField1(AuthoringInfoField) Method

Asynchronously set the value of the Field1 property after render.

public System.Threading.Tasks.Task SetField1(dymaptic.GeoBlazor.Core.Components.AuthoringInfoField? value);

Parameters

value AuthoringInfoField

The value to set.

Returns

System.Threading.Tasks.Task

AuthoringInfo.SetField2(AuthoringInfoField) Method

Asynchronously set the value of the Field2 property after render.

public System.Threading.Tasks.Task SetField2(dymaptic.GeoBlazor.Core.Components.AuthoringInfoField? value);

Parameters

value AuthoringInfoField

The value to set.

Returns

System.Threading.Tasks.Task

AuthoringInfo.SetFields(IReadOnlyList) Method

Asynchronously set the value of the Fields property after render.

public System.Threading.Tasks.Task SetFields(System.Collections.Generic.IReadOnlyList<string>? value);

Parameters

value System.Collections.Generic.IReadOnlyList<System.String>

The value to set.

Returns

System.Threading.Tasks.Task

AuthoringInfo.SetFlowTheme(Nullable) Method

Asynchronously set the value of the FlowTheme property after render.

public System.Threading.Tasks.Task SetFlowTheme(System.Nullable<dymaptic.GeoBlazor.Core.Enums.AuthoringInfoFlowTheme> value);

Parameters

value System.Nullable<AuthoringInfoFlowTheme>

The value to set.

Returns

System.Threading.Tasks.Task

AuthoringInfo.SetFocus(string) Method

Asynchronously set the value of the Focus property after render.

public System.Threading.Tasks.Task SetFocus(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

AuthoringInfo.SetIsAutoGenerated(Nullable) Method

Asynchronously set the value of the IsAutoGenerated property after render.

public System.Threading.Tasks.Task SetIsAutoGenerated(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

AuthoringInfo.SetLengthUnit(Nullable) Method

Asynchronously set the value of the LengthUnit property after render.

public System.Threading.Tasks.Task SetLengthUnit(System.Nullable<dymaptic.GeoBlazor.Core.Enums.LengthUnit> value);

Parameters

value System.Nullable<LengthUnit>

The value to set.

Returns

System.Threading.Tasks.Task

AuthoringInfo.SetMaxSliderValue(Nullable) Method

Asynchronously set the value of the MaxSliderValue property after render.

public System.Threading.Tasks.Task SetMaxSliderValue(System.Nullable<double> value);

Parameters

value System.Nullable<System.Double>

The value to set.

Returns

System.Threading.Tasks.Task

AuthoringInfo.SetMinSliderValue(Nullable) Method

Asynchronously set the value of the MinSliderValue property after render.

public System.Threading.Tasks.Task SetMinSliderValue(System.Nullable<double> value);

Parameters

value System.Nullable<System.Double>

The value to set.

Returns

System.Threading.Tasks.Task

AuthoringInfo.SetNumClasses(Nullable) Method

Asynchronously set the value of the NumClasses property after render.

public System.Threading.Tasks.Task SetNumClasses(System.Nullable<double> value);

Parameters

value System.Nullable<System.Double>

The value to set.

Returns

System.Threading.Tasks.Task

AuthoringInfo.SetStandardDeviationInterval(Nullable) Method

Asynchronously set the value of the StandardDeviationInterval property after render.

public System.Threading.Tasks.Task SetStandardDeviationInterval(System.Nullable<double> value);

Parameters

value System.Nullable<System.Double>

The value to set.

Returns

System.Threading.Tasks.Task

AuthoringInfo.SetStatistics(AuthoringInfoStatistics) Method

Asynchronously set the value of the Statistics property after render.

public System.Threading.Tasks.Task SetStatistics(dymaptic.GeoBlazor.Core.Components.AuthoringInfoStatistics? value);

Parameters

value AuthoringInfoStatistics

The value to set.

Returns

System.Threading.Tasks.Task

AuthoringInfo.SetUnivariateSymbolStyle(Nullable) Method

Asynchronously set the value of the UnivariateSymbolStyle property after render.

public System.Threading.Tasks.Task SetUnivariateSymbolStyle(System.Nullable<dymaptic.GeoBlazor.Core.Enums.UnivariateSymbolStyle> value);

Parameters

value System.Nullable<UnivariateSymbolStyle>

The value to set.

Returns

System.Threading.Tasks.Task

AuthoringInfo.SetUnivariateTheme(Nullable) Method

Asynchronously set the value of the UnivariateTheme property after render.

public System.Threading.Tasks.Task SetUnivariateTheme(System.Nullable<dymaptic.GeoBlazor.Core.Enums.UnivariateTheme> value);

Parameters

value System.Nullable<UnivariateTheme>

The value to set.

Returns

System.Threading.Tasks.Task

AuthoringInfo.SetVisualVariables(IReadOnlyList) Method

Asynchronously set the value of the VisualVariables property after render.

public System.Threading.Tasks.Task SetVisualVariables(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.AuthoringInfoVisualVariable>? value);

Parameters

value System.Collections.Generic.IReadOnlyList<AuthoringInfoVisualVariable>

The value to set.

Returns

System.Threading.Tasks.Task

AuthoringInfo.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()