GeoBlazor Pro


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

dymaptic.GeoBlazor.Pro

dymaptic.GeoBlazor.Pro.Model

PieChartRendererParams Class

Input parameters for generating a pie chart visualization based on a set of numeric fields.

public class PieChartRendererParams :
System.IEquatable<dymaptic.GeoBlazor.Pro.Model.PieChartRendererParams>

Inheritance System.Object 🡒 PieChartRendererParams

Implements System.IEquatable<PieChartRendererParams>

Constructors

PieChartRendererParams(Layer, Guid, IReadOnlyCollection, string, Nullable, Nullable, Nullable, LegendOptions, PieChartScheme, Nullable) Constructor

Input parameters for generating a pie chart visualization based on a set of numeric fields.

public PieChartRendererParams(dymaptic.GeoBlazor.Core.Components.Layers.Layer Layer, System.Guid ViewId, System.Collections.Generic.IReadOnlyCollection<dymaptic.GeoBlazor.Pro.Components.Renderers.AttributeColorInfo> Attributes, string? Shape, System.Nullable<bool> IncludeSizeVariable, System.Nullable<bool> OutlineOptimizationEnabled, System.Nullable<bool> SizeOptimizationEnabled, dymaptic.GeoBlazor.Core.Components.Layers.LegendOptions? LegendOptions, dymaptic.GeoBlazor.Pro.Model.PieChartScheme? PieChartScheme, System.Nullable<bool> ForBinning);

Parameters

Layer dymaptic.GeoBlazor.Core.Components.Layers.Layer

The layer for which the visualization is generated.

ViewId System.Guid

The view instance in which the visualization will be rendered.

Attributes System.Collections.Generic.IReadOnlyCollection<AttributeColorInfo>

A set of complementary numeric fields/expressions used to create the charts. For example, if creating an election map, you would indicate the name of each field representing the candidate or political party where their total counts are stored.

Shape System.String

Default Value: “pie”
Determines whether to create a pie chart or a donut chart.

IncludeSizeVariable System.Nullable<System.Boolean>

Indicates whether to include data-driven size in the final renderer. If true, features will be assigned a sized based on the sum of all values in the attributes param. Features with small total counts will be sized with small charts and features with large total counts will be sized with large charts. Enabling this option is good for visualizing how influential a particular feature is compared to the dataset as a whole. It removes bias introduced by features with large geographic areas, but relatively small data values.

OutlineOptimizationEnabled System.Nullable<System.Boolean>

Default Value: false
Only for polygon layers. Indicates whether the polygon’s background fill symbol outline width should vary based on view scale.

SizeOptimizationEnabled System.Nullable<System.Boolean>

Default Value: false
Indicates whether chart sizes should vary based on view scale.

LegendOptions dymaptic.GeoBlazor.Core.Components.Layers.LegendOptions

Provides options for modifying Legend properties describing the visualization.

PieChartScheme PieChartScheme

In authoring apps, the user may select a pre-defined color scheme. Pass the scheme object to this property to avoid getting one based on the background of the view.

ForBinning System.Nullable<System.Boolean>

Indicates whether the generated renderer is for a binning visualization. If true, then the input field(s) in this method should refer to aggregate fields defined in the featureReduction property of the layer.

Properties

PieChartRendererParams.Attributes Property

A set of complementary numeric fields/expressions used to create the charts. For example, if creating an election map, you would indicate the name of each field representing the candidate or political party where their total counts are stored.

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

Property Value

System.Collections.Generic.IReadOnlyCollection<AttributeColorInfo>

PieChartRendererParams.ForBinning Property

Indicates whether the generated renderer is for a binning visualization. If true, then the input field(s) in this method should refer to aggregate fields defined in the featureReduction property of the layer.

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

Property Value

System.Nullable<System.Boolean>

PieChartRendererParams.IncludeSizeVariable Property

Indicates whether to include data-driven size in the final renderer. If true, features will be assigned a sized based on the sum of all values in the attributes param. Features with small total counts will be sized with small charts and features with large total counts will be sized with large charts. Enabling this option is good for visualizing how influential a particular feature is compared to the dataset as a whole. It removes bias introduced by features with large geographic areas, but relatively small data values.

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

Property Value

System.Nullable<System.Boolean>

PieChartRendererParams.Layer Property

The layer for which the visualization is generated.

public dymaptic.GeoBlazor.Core.Components.Layers.Layer Layer { get; set; }

Property Value

dymaptic.GeoBlazor.Core.Components.Layers.Layer

PieChartRendererParams.LegendOptions Property

Provides options for modifying Legend properties describing the visualization.

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

Property Value

dymaptic.GeoBlazor.Core.Components.Layers.LegendOptions

PieChartRendererParams.OutlineOptimizationEnabled Property

Default Value: false
Only for polygon layers. Indicates whether the polygon’s background fill symbol outline width should vary based on view scale.

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

Property Value

System.Nullable<System.Boolean>

PieChartRendererParams.PieChartScheme Property

In authoring apps, the user may select a pre-defined color scheme. Pass the scheme object to this property to avoid getting one based on the background of the view.

public dymaptic.GeoBlazor.Pro.Model.PieChartScheme? PieChartScheme { get; set; }

Property Value

PieChartScheme

PieChartRendererParams.Shape Property

Default Value: “pie”
Determines whether to create a pie chart or a donut chart.

public string? Shape { get; set; }

Property Value

System.String

PieChartRendererParams.SizeOptimizationEnabled Property

Default Value: false
Indicates whether chart sizes should vary based on view scale.

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

Property Value

System.Nullable<System.Boolean>

PieChartRendererParams.ViewId Property

The view instance in which the visualization will be rendered.

public System.Guid ViewId { get; set; }

Property Value

System.Guid