dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components
FeatureReductionBinning Class
Aggregates and summarizes dense features in a layer to bins in geographic space based on predefined geohashes. ArcGIS Maps SDK for JavaScript
public class FeatureReductionBinning : dymaptic.GeoBlazor.Pro.Components.Layers.FeatureReduction
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 FeatureReduction 🡒 FeatureReductionBinning
Constructors
FeatureReductionBinning() Constructor
Parameterless constructor for use as a Razor Component.
public FeatureReductionBinning();
FeatureReductionBinning(Nullable, Nullable, Nullable, Nullable, IReadOnlyList, IReadOnlyList
Constructor for use in code
public FeatureReductionBinning(System.Nullable<int> fixedBinLevel=null, System.Nullable<bool> labelsVisible=null, System.Nullable<double> maxScale=null, System.Nullable<bool> popupEnabled=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.AggregateField>? fields=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Label>? labelingInfo=null, dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate? popupTemplate=null, dymaptic.GeoBlazor.Core.Components.Renderers.Renderer? renderer=null);
Parameters
fixedBinLevel System.Nullable<System.Int32>
The fixed geohash level used to create bins. default 3 ArcGIS Maps SDK for JavaScript
labelsVisible System.Nullable<System.Boolean>
Indicates whether to display labels for the bins. default true ArcGIS Maps SDK for JavaScript
maxScale System.Nullable<System.Double>
Defines the maximum view scale at which binning is enabled. default 0 ArcGIS Maps SDK for JavaScript
popupEnabled System.Nullable<System.Boolean>
Indicates whether to display a popup when a user clicks or touches a bin. default true ArcGIS Maps SDK for JavaScript
fields System.Collections.Generic.IReadOnlyList<AggregateField>
An array of aggregate fields that summarize layer fields from features contained within each bin. ArcGIS Maps SDK for JavaScript
labelingInfo System.Collections.Generic.IReadOnlyList<Label>
Defines labels for bins as an array of LabelClass. ArcGIS Maps SDK for JavaScript
popupTemplate PopupTemplate
The PopupTemplate to apply to bins. ArcGIS Maps SDK for JavaScript
renderer Renderer
The renderer used to style the bins. ArcGIS Maps SDK for JavaScript
Properties
FeatureReductionBinning.Fields Property
An array of aggregate fields that summarize layer fields from features contained within each bin. ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.AggregateField>? Fields { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<AggregateField>
FeatureReductionBinning.FixedBinLevel Property
The fixed geohash level used to create bins. Currently, bin sizes do not dynamically change as the user zooms in and out of the map. Larger numbers will create smaller bins. Levels range from 1 - 9. See fixedBinLevel to see which bin level to use depending on the approximate view scale. Default Value: 3
public System.Nullable<int> FixedBinLevel { get; set; }
Property Value
FeatureReductionBinning.LabelingInfo Property
Defines labels for bins as an array of LabelClass. ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Label>? LabelingInfo { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<Label>
FeatureReductionBinning.LabelsVisible Property
Indicates whether to display labels for the bins. If true, labels will appear as defined in the LabelingInfo property. Default Value:true
public System.Nullable<bool> LabelsVisible { get; set; }
Property Value
System.Nullable<System.Boolean>
FeatureReductionBinning.MaxScale Property
Defines the maximum view scale at which binning is enabled. If the user zooms in beyond the scale specified here, binning will be disabled and only individual features will be displayed in the view. Once the user zooms out past this scale, binning will be re-enabled. A value of 0 means binning is always enabled, and therefore binning will be visible at all view scales. Default Value:0
public System.Nullable<double> MaxScale { get; set; }
Property Value
System.Nullable<System.Double>
FeatureReductionBinning.PopupEnabled Property
Indicates whether to display a popup when a user clicks or touches a bin. If false, the popup as defined in the popupTemplate will be persisted, but won't be displayed on click/tap. Default Value:true
public System.Nullable<bool> PopupEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
FeatureReductionBinning.PopupTemplate Property
The PopupTemplate to apply to bins. ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate? PopupTemplate { get; set; }
Property Value
FeatureReductionBinning.Renderer Property
The renderer used to style the bins. ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Renderers.Renderer? Renderer { get; set; }
Property Value
FeatureReductionBinning.Type Property
The type of Feature Reduction
public override string Type { get; }
Property Value
Methods
FeatureReductionBinning.AddToFields(AggregateField[]) Method
Asynchronously adds elements to the Fields property.
public System.Threading.Tasks.Task AddToFields(params dymaptic.GeoBlazor.Core.Components.AggregateField[] values);
Parameters
values AggregateField[]
The elements to add.
Returns
FeatureReductionBinning.AddToLabelingInfo(Label[]) Method
Asynchronously adds elements to the LabelingInfo property.
public System.Threading.Tasks.Task AddToLabelingInfo(params dymaptic.GeoBlazor.Core.Components.Label[] values);
Parameters
The elements to add.
Returns
FeatureReductionBinning.GetFields() Method
Asynchronously retrieve the current value of the Fields property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.AggregateField>?> GetFields();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<AggregateField>>
FeatureReductionBinning.GetFixedBinLevel() Method
Asynchronously retrieve the current value of the FixedBinLevel property.
public System.Threading.Tasks.Task<System.Nullable<int>> GetFixedBinLevel();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Int32>>
FeatureReductionBinning.GetLabelingInfo() Method
Asynchronously retrieve the current value of the LabelingInfo property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Label>?> GetLabelingInfo();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Label>>
FeatureReductionBinning.GetLabelsVisible() Method
Asynchronously retrieve the current value of the LabelsVisible property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetLabelsVisible();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
FeatureReductionBinning.GetMaxScale() Method
Asynchronously retrieve the current value of the MaxScale property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetMaxScale();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
FeatureReductionBinning.GetPopupEnabled() Method
Asynchronously retrieve the current value of the PopupEnabled property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetPopupEnabled();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
FeatureReductionBinning.GetPopupTemplate() Method
Asynchronously retrieve the current value of the PopupTemplate property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate?> GetPopupTemplate();
Returns
System.Threading.Tasks.Task<PopupTemplate>
FeatureReductionBinning.GetRenderer() Method
Asynchronously retrieve the current value of the Renderer property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Renderers.Renderer?> GetRenderer();
Returns
System.Threading.Tasks.Task<Renderer>
FeatureReductionBinning.RegisterChildComponent(MapComponent) Method
Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnInitializedAsync to "Register" the current component with its parent.
public override System.Threading.Tasks.Task RegisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);
Parameters
child MapComponent
The calling, child component to register
Returns
Exceptions
InvalidChildElementException
Throws if the current child is not a valid sub-component to the parent.
Remarks
This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method. If you see no other way to register a child component, please open an issue on GitHub.
FeatureReductionBinning.RemoveFromFields(AggregateField[]) Method
Asynchronously remove an element from the Fields property.
public System.Threading.Tasks.Task RemoveFromFields(params dymaptic.GeoBlazor.Core.Components.AggregateField[] values);
Parameters
values AggregateField[]
The elements to remove.
Returns
FeatureReductionBinning.RemoveFromLabelingInfo(Label[]) Method
Asynchronously remove an element from the LabelingInfo property.
public System.Threading.Tasks.Task RemoveFromLabelingInfo(params dymaptic.GeoBlazor.Core.Components.Label[] values);
Parameters
The elements to remove.
Returns
FeatureReductionBinning.SetFields(IReadOnlyList) Method
Asynchronously set the value of the Fields property after render.
public System.Threading.Tasks.Task SetFields(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.AggregateField> value);
Parameters
value System.Collections.Generic.IReadOnlyList<AggregateField>
The value to set.
Returns
FeatureReductionBinning.SetFixedBinLevel(Nullable) Method
Asynchronously set the value of the FixedBinLevel property after render.
public System.Threading.Tasks.Task SetFixedBinLevel(System.Nullable<int> value);
Parameters
value System.Nullable<System.Int32>
The value to set.
Returns
FeatureReductionBinning.SetLabelingInfo(IReadOnlyList
Asynchronously set the value of the LabelingInfo property after render.
public System.Threading.Tasks.Task SetLabelingInfo(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Label> value);
Parameters
value System.Collections.Generic.IReadOnlyList<Label>
The value to set.
Returns
FeatureReductionBinning.SetLabelsVisible(Nullable) Method
Asynchronously set the value of the LabelsVisible property after render.
public System.Threading.Tasks.Task SetLabelsVisible(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
FeatureReductionBinning.SetMaxScale(Nullable) Method
Asynchronously set the value of the MaxScale property after render.
public System.Threading.Tasks.Task SetMaxScale(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
FeatureReductionBinning.SetPopupEnabled(Nullable) Method
Asynchronously set the value of the PopupEnabled property after render.
public System.Threading.Tasks.Task SetPopupEnabled(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
FeatureReductionBinning.SetPopupTemplate(PopupTemplate) Method
Asynchronously set the value of the PopupTemplate property after render.
public System.Threading.Tasks.Task SetPopupTemplate(dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate? value);
Parameters
value PopupTemplate
The value to set.
Returns
FeatureReductionBinning.SetRenderer(Renderer) Method
Asynchronously set the value of the Renderer property after render.
public System.Threading.Tasks.Task SetRenderer(dymaptic.GeoBlazor.Core.Components.Renderers.Renderer? value);
Parameters
value Renderer
The value to set.
Returns
FeatureReductionBinning.UnregisterChildComponent(MapComponent) Method
Undoes the "Registration" of a child with its parent.
public override System.Threading.Tasks.Task UnregisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);
Parameters
child MapComponent
The child to unregister
Returns
Remarks
This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method.
FeatureReductionBinning.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()