GeoBlazor Pro

dymaptic.GeoBlazor.Pro

dymaptic.GeoBlazor.Pro.Components.Renderers

PieChartRenderer Class

PieChartRenderer allows you to create a pie chart for each feature in the layer.
ArcGIS Maps SDK for JavaScript

public class PieChartRenderer : dymaptic.GeoBlazor.Core.Components.Renderers.Renderer,
dymaptic.GeoBlazor.Core.Interfaces.IRendererWithVisualVariables,
dymaptic.GeoBlazor.Core.Interfaces.IRenderersRenderer,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 dymaptic.GeoBlazor.Core.Components.MapComponent 🡒 dymaptic.GeoBlazor.Core.Components.Renderers.Renderer 🡒 PieChartRenderer

Implements dymaptic.GeoBlazor.Core.Interfaces.IRendererWithVisualVariables, dymaptic.GeoBlazor.Core.Interfaces.IRenderersRenderer, dymaptic.GeoBlazor.Core.Interfaces.IMapComponent

Constructors

PieChartRenderer() Constructor

Parameterless constructor for use as a Razor Component.

public PieChartRenderer();

PieChartRenderer(IReadOnlyList, AuthoringInfo, Symbol, MapColor, string, Nullable, PieChartLegendOptions, PieChartOthersCategory, Outline, Dimension, IReadOnlyList) Constructor

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

public PieChartRenderer(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.AttributeColorInfo>? attributes=null, dymaptic.GeoBlazor.Core.Components.AuthoringInfo? authoringInfo=null, dymaptic.GeoBlazor.Core.Components.Symbols.Symbol? backgroundFillSymbol=null, dymaptic.GeoBlazor.Core.Model.MapColor? defaultColor=null, string? defaultLabel=null, System.Nullable<double> holePercentage=null, dymaptic.GeoBlazor.Pro.Options.PieChartLegendOptions? legendOptions=null, dymaptic.GeoBlazor.Pro.Components.PieChartOthersCategory? othersCategory=null, dymaptic.GeoBlazor.Core.Components.Symbols.Outline? outline=null, dymaptic.GeoBlazor.Core.Model.Dimension? size=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.VisualVariable>? visualVariables=null);

Parameters

attributes System.Collections.Generic.IReadOnlyList<AttributeColorInfo>

Defines the variable(s) to include in the pie charts.
ArcGIS Maps SDK for JavaScript

authoringInfo dymaptic.GeoBlazor.Core.Components.AuthoringInfo

Authoring metadata only included in renderers generated from one of the
Smart Mapping creator methods, such as
sizeRendererCreator.createContinuousRenderer() or
colorRendererCreator.createContinuousRenderer().
ArcGIS Maps SDK for JavaScript

backgroundFillSymbol dymaptic.GeoBlazor.Core.Components.Symbols.Symbol

The symbol used to render polygons behind the pie symbols.
ArcGIS Maps SDK for JavaScript

defaultColor dymaptic.GeoBlazor.Core.Model.MapColor

The color used to visualize features whose attributes all have null or empty values.
default new Color([0, 0, 0, 0])
ArcGIS Maps SDK for JavaScript

defaultLabel System.String

Describes the defaultColor in the Legend.
ArcGIS Maps SDK for JavaScript

holePercentage System.Nullable<System.Double>

Use this property to create a donut chart.
default 0
ArcGIS Maps SDK for JavaScript

legendOptions PieChartLegendOptions

An object providing options for describing the renderer in the Legend.
ArcGIS Maps SDK for JavaScript

othersCategory PieChartOthersCategory

Defines the rules for how to aggregate small categories to a generic “others” category.
ArcGIS Maps SDK for JavaScript

outline dymaptic.GeoBlazor.Core.Components.Symbols.Outline

Defines the outline of the pie chart.
ArcGIS Maps SDK for JavaScript

size dymaptic.GeoBlazor.Core.Model.Dimension

Defines the size of each pie chart in points.
default 12
ArcGIS Maps SDK for JavaScript

visualVariables System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.VisualVariable>

An array of Size Visual Variable objects.
ArcGIS Maps SDK for JavaScript

Properties

PieChartRenderer.Attributes Property

Defines the variable(s) to include in the pie charts.
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.AttributeColorInfo>? Attributes { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<AttributeColorInfo>

PieChartRenderer.BackgroundFillSymbol Property

The symbol used to render polygons behind the pie symbols.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.Symbols.Symbol? BackgroundFillSymbol { get; set; }

Property Value

dymaptic.GeoBlazor.Core.Components.Symbols.Symbol

PieChartRenderer.DefaultColor Property

The color used to visualize features whose attributes all have null or empty values. By default, this is a transparent color, so no chart displays. You should set this value if you would like to show areas with features, but no data associated with it.
Default Value:new MapColor(0, 0, 0, 0)

public dymaptic.GeoBlazor.Core.Model.MapColor? DefaultColor { get; set; }

Property Value

dymaptic.GeoBlazor.Core.Model.MapColor

PieChartRenderer.DefaultLabel Property

Describes the defaultColor in the Legend.

public string? DefaultLabel { get; set; }

Property Value

System.String

PieChartRenderer.HolePercentage Property

Use this property to create a donut chart. Defines the size of the hole to cut from the center of the chart as a percentage of the entire pie chart. Accepted values are between 0 and 1. For example, a hole percentage of 0 will render a full pie chart. A ratio of 0.5 will remove 50% of the center of the pie, creating a donut.
Default Value:0

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

Property Value

System.Nullable<System.Double>

PieChartRenderer.LegendOptions Property

An object providing options for describing the renderer in the Legend.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Pro.Options.PieChartLegendOptions? LegendOptions { get; set; }

Property Value

PieChartLegendOptions

PieChartRenderer.OthersCategory Property

Defines the rules for how to aggregate small categories to a generic “others” category.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Pro.Components.PieChartOthersCategory? OthersCategory { get; set; }

Property Value

PieChartOthersCategory

PieChartRenderer.Outline Property

Defines the outline of the pie chart.
ArcGIS Maps SDK for JavaScript

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

Property Value

dymaptic.GeoBlazor.Core.Components.Symbols.Outline

PieChartRenderer.Size Property

Defines the size of each pie chart in points. This value may be autocast with a string expressing size in points or pixels (e.g. 12px).
Default Value:12

public dymaptic.GeoBlazor.Core.Model.Dimension? Size { get; set; }

Property Value

dymaptic.GeoBlazor.Core.Model.Dimension

PieChartRenderer.Type Property

The subclass Renderer type

public override dymaptic.GeoBlazor.Core.Enums.RendererType Type { get; }

Property Value

dymaptic.GeoBlazor.Core.Enums.RendererType

PieChartRenderer.VisualVariables Property

An array of Size Visual Variable objects.
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.VisualVariable>

Methods

PieChartRenderer.AddToAttributes(AttributeColorInfo[]) Method

Asynchronously adds elements to the Attributes property.

public System.Threading.Tasks.Task AddToAttributes(params dymaptic.GeoBlazor.Pro.Components.AttributeColorInfo[] values);

Parameters

values AttributeColorInfo[]

The elements to add.

Returns

System.Threading.Tasks.Task

PieChartRenderer.AddToVisualVariables(VisualVariable[]) Method

Asynchronously adds elements to the VisualVariables property.

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

Parameters

values dymaptic.GeoBlazor.Core.Components.VisualVariable[]

The elements to add.

Returns

System.Threading.Tasks.Task

PieChartRenderer.GetAttributes() Method

Asynchronously retrieve the current value of the Attributes property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.AttributeColorInfo>?> GetAttributes();

Returns

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

PieChartRenderer.GetBackgroundFillSymbol() Method

Asynchronously retrieve the current value of the BackgroundFillSymbol property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Symbols.Symbol?> GetBackgroundFillSymbol();

Returns

System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Symbols.Symbol>

PieChartRenderer.GetDefaultColor() Method

Asynchronously retrieve the current value of the DefaultColor property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.MapColor?> GetDefaultColor();

Returns

System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.MapColor>

PieChartRenderer.GetDefaultLabel() Method

Asynchronously retrieve the current value of the DefaultLabel property.

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

Returns

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

PieChartRenderer.GetHolePercentage() Method

Asynchronously retrieve the current value of the HolePercentage property.

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

Returns

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

PieChartRenderer.GetLegendOptions() Method

Asynchronously retrieve the current value of the LegendOptions property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Options.PieChartLegendOptions?> GetLegendOptions();

Returns

System.Threading.Tasks.Task<PieChartLegendOptions>

PieChartRenderer.GetOthersCategory() Method

Asynchronously retrieve the current value of the OthersCategory property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.PieChartOthersCategory?> GetOthersCategory();

Returns

System.Threading.Tasks.Task<PieChartOthersCategory>

PieChartRenderer.GetOutline() Method

Asynchronously retrieve the current value of the Outline property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Symbols.Outline?> GetOutline();

Returns

System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Symbols.Outline>

PieChartRenderer.GetSize() Method

Asynchronously retrieve the current value of the Size property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.Dimension?> GetSize();

Returns

System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.Dimension>

PieChartRenderer.GetVisualVariables() Method

Asynchronously retrieve the current value of the VisualVariables property.

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

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.VisualVariable>>

PieChartRenderer.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 dymaptic.GeoBlazor.Core.Components.MapComponent

The calling, child component to register

Returns

System.Threading.Tasks.Task

Exceptions

dymaptic.GeoBlazor.Core.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.

PieChartRenderer.RemoveFromAttributes(AttributeColorInfo[]) Method

Asynchronously remove an element from the Attributes property.

public System.Threading.Tasks.Task RemoveFromAttributes(params dymaptic.GeoBlazor.Pro.Components.AttributeColorInfo[] values);

Parameters

values AttributeColorInfo[]

The elements to remove.

Returns

System.Threading.Tasks.Task

PieChartRenderer.RemoveFromVisualVariables(VisualVariable[]) Method

Asynchronously remove an element from the VisualVariables property.

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

Parameters

values dymaptic.GeoBlazor.Core.Components.VisualVariable[]

The elements to remove.

Returns

System.Threading.Tasks.Task

PieChartRenderer.SetAttributes(IReadOnlyList) Method

Asynchronously set the value of the Attributes property after render.

public System.Threading.Tasks.Task SetAttributes(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.AttributeColorInfo>? value);

Parameters

value System.Collections.Generic.IReadOnlyList<AttributeColorInfo>

The value to set.

Returns

System.Threading.Tasks.Task

PieChartRenderer.SetBackgroundFillSymbol(Symbol) Method

Asynchronously set the value of the BackgroundFillSymbol property after render.

public System.Threading.Tasks.Task SetBackgroundFillSymbol(dymaptic.GeoBlazor.Core.Components.Symbols.Symbol? value);

Parameters

value dymaptic.GeoBlazor.Core.Components.Symbols.Symbol

The value to set.

Returns

System.Threading.Tasks.Task

PieChartRenderer.SetDefaultColor(MapColor) Method

Asynchronously set the value of the DefaultColor property after render.

public System.Threading.Tasks.Task SetDefaultColor(dymaptic.GeoBlazor.Core.Model.MapColor? value);

Parameters

value dymaptic.GeoBlazor.Core.Model.MapColor

The value to set.

Returns

System.Threading.Tasks.Task

PieChartRenderer.SetDefaultLabel(string) Method

Asynchronously set the value of the DefaultLabel property after render.

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

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

PieChartRenderer.SetHolePercentage(Nullable) Method

Asynchronously set the value of the HolePercentage property after render.

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

Parameters

value System.Nullable<System.Double>

The value to set.

Returns

System.Threading.Tasks.Task

PieChartRenderer.SetLegendOptions(PieChartLegendOptions) Method

Asynchronously set the value of the LegendOptions property after render.

public System.Threading.Tasks.Task SetLegendOptions(dymaptic.GeoBlazor.Pro.Options.PieChartLegendOptions? value);

Parameters

value PieChartLegendOptions

The value to set.

Returns

System.Threading.Tasks.Task

PieChartRenderer.SetOthersCategory(PieChartOthersCategory) Method

Asynchronously set the value of the OthersCategory property after render.

public System.Threading.Tasks.Task SetOthersCategory(dymaptic.GeoBlazor.Pro.Components.PieChartOthersCategory? value);

Parameters

value PieChartOthersCategory

The value to set.

Returns

System.Threading.Tasks.Task

PieChartRenderer.SetOutline(Outline) Method

Asynchronously set the value of the Outline property after render.

public System.Threading.Tasks.Task SetOutline(dymaptic.GeoBlazor.Core.Components.Symbols.Outline? value);

Parameters

value dymaptic.GeoBlazor.Core.Components.Symbols.Outline

The value to set.

Returns

System.Threading.Tasks.Task

PieChartRenderer.SetSize(Dimension) Method

Asynchronously set the value of the Size property after render.

public System.Threading.Tasks.Task SetSize(dymaptic.GeoBlazor.Core.Model.Dimension? value);

Parameters

value dymaptic.GeoBlazor.Core.Model.Dimension

The value to set.

Returns

System.Threading.Tasks.Task

PieChartRenderer.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.VisualVariable>? value);

Parameters

value System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.VisualVariable>

The value to set.

Returns

System.Threading.Tasks.Task

PieChartRenderer.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 dymaptic.GeoBlazor.Core.Components.MapComponent

The child to unregister

Returns

System.Threading.Tasks.Task

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.

PieChartRenderer.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()