dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Renderers
RasterStretchRenderer Class
RasterStretchRenderer defines the symbology with a gradual ramp of colors for each pixel in a ImageryLayer,
ImageryTileLayer, and WCSLayer based on the pixel value.
ArcGIS Maps SDK for JavaScript
public class RasterStretchRenderer : dymaptic.GeoBlazor.Core.Components.MapComponent,
dymaptic.GeoBlazor.Core.Interfaces.IImageryRenderer
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 RasterStretchRenderer
Implements IImageryRenderer
Constructors
RasterStretchRenderer() Constructor
Parameterless constructor for use as a Razor Component.
public RasterStretchRenderer();
RasterStretchRenderer(ColorRamp, Nullable, Nullable, IReadOnlyList, Nullable, Nullable, Nullable, Nullable, Nullable, IReadOnlyList, Nullable, Nullable, Nullable) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public RasterStretchRenderer(dymaptic.GeoBlazor.Core.Components.ColorRamp? colorRamp=null, System.Nullable<bool> computeGamma=null, System.Nullable<bool> dynamicRangeAdjustment=null, System.Collections.Generic.IReadOnlyList<double>? gamma=null, System.Nullable<int> outputMax=null, System.Nullable<int> outputMin=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.StretchType> stretchType=null, System.Nullable<bool> useGamma=null, System.Nullable<int> numberOfStandardDeviations=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.RasterBandStatistics>? customStatistics=null, System.Nullable<double> maxPercent=null, System.Nullable<double> minPercent=null, System.Nullable<double> sigmoidStrengthLevel=null);
Parameters
colorRamp ColorRamp
The stretched values are mapped to this specified color ramp.
ArcGIS Maps SDK for JavaScript
computeGamma System.Nullable<System.Boolean>
The computeGamma automatically calculates best gamma value to render exported image based on empirical model.
default false
ArcGIS Maps SDK for JavaScript
dynamicRangeAdjustment System.Nullable<System.Boolean>
When Dynamic Range Adjustment is true, the statistics based on the current display extent
are calculated as you zoom and pan around the image.
default false
ArcGIS Maps SDK for JavaScript
gamma System.Collections.Generic.IReadOnlyList<System.Double>
The gamma values to be used if useGamma is set to true.
ArcGIS Maps SDK for JavaScript
outputMax System.Nullable<System.Int32>
The outputMax denotes the output maximum, which is the highest pixel value.
ArcGIS Maps SDK for JavaScript
outputMin System.Nullable<System.Int32>
The outputMin denotes the output minimum, which is the lowest pixel value.
ArcGIS Maps SDK for JavaScript
stretchType System.Nullable<StretchType>
The stretch type defines a histogram stretch that will be applied to the rasters to enhance their appearance.
default “none”
ArcGIS Maps SDK for JavaScript
useGamma System.Nullable<System.Boolean>
Denotes whether the gamma value should be used.
default false
ArcGIS Maps SDK for JavaScript
numberOfStandardDeviations System.Nullable<System.Int32>
Applicable when stretchType is standard-deviation.
ArcGIS Maps SDK for JavaScript
customStatistics System.Collections.Generic.IReadOnlyList<RasterBandStatistics>
The input band statistics can be specified through the customStatistics property.
ArcGIS Maps SDK for JavaScript
maxPercent System.Nullable<System.Double>
Applicable when stretchType is percent-clip.
ArcGIS Maps SDK for JavaScript
minPercent System.Nullable<System.Double>
Applicable when stretchType is percent-clip.
ArcGIS Maps SDK for JavaScript
sigmoidStrengthLevel System.Nullable<System.Double>
The sigmoid strength level determines how much of the sigmoidal function will be used in the stretch.
ArcGIS Maps SDK for JavaScript
Properties
RasterStretchRenderer.ColorRamp Property
The stretched values are mapped to this specified color ramp.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.ColorRamp? ColorRamp { get; set; }
Property Value
RasterStretchRenderer.ComputeGamma Property
The computeGamma automatically calculates best gamma value to render exported image based on empirical model. This is applicable to any stretch type when useGamma is true.
public System.Nullable<bool> ComputeGamma { get; set; }
Property Value
System.Nullable<System.Boolean>
RasterStretchRenderer.CustomStatistics Property
The input band statistics can be specified through the customStatistics property.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.RasterBandStatistics>? CustomStatistics { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<RasterBandStatistics>
RasterStretchRenderer.DynamicRangeAdjustment Property
When Dynamic Range Adjustment is true, the statistics based on the current display extent are calculated as you zoom and pan around the image. This property only applies to images in 2D MapView.
public System.Nullable<bool> DynamicRangeAdjustment { get; set; }
Property Value
System.Nullable<System.Boolean>
RasterStretchRenderer.Gamma Property
The gamma values to be used if useGamma is set to true.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<double>? Gamma { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<System.Double>
RasterStretchRenderer.MaxPercent Property
Applicable when stretchType is percent-clip.
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> MaxPercent { get; set; }
Property Value
System.Nullable<System.Double>
RasterStretchRenderer.MinPercent Property
Applicable when stretchType is percent-clip.
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> MinPercent { get; set; }
Property Value
System.Nullable<System.Double>
RasterStretchRenderer.NumberOfStandardDeviations Property
Applicable when stretchType is standard-deviation. Specifies the number of standard deviations to use. The values beyond the number of standard deviations become the outputMin and outputMax. The remaining values are linearly stretched between outputMin and outputMax.
public System.Nullable<int> NumberOfStandardDeviations { get; set; }
Property Value
RasterStretchRenderer.OutputMax Property
The outputMax denotes the output maximum, which is the highest pixel value. The outputMin and outputMax will set the range of values that will then be linearly contrast stretched. The outputMax value ranges from 0-255.
public System.Nullable<int> OutputMax { get; set; }
Property Value
RasterStretchRenderer.OutputMin Property
The outputMin denotes the output minimum, which is the lowest pixel value. The outputMin and outputMax will set the range of values that will then be linearly contrast stretched. The outputMin value ranges from 0-255.
public System.Nullable<int> OutputMin { get; set; }
Property Value
RasterStretchRenderer.SigmoidStrengthLevel Property
The sigmoid strength level determines how much of the sigmoidal function will be used in the stretch.
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> SigmoidStrengthLevel { get; set; }
Property Value
System.Nullable<System.Double>
RasterStretchRenderer.StretchType Property
The stretch type defines a histogram stretch that will be applied to the rasters to enhance their appearance. Stretching improves the appearance of the data by spreading the pixel values along a histogram from the minimum and maximum values defined by their bit depth.
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.StretchType> StretchType { get; set; }
Property Value
RasterStretchRenderer.Type Property
The type of renderer.
public dymaptic.GeoBlazor.Core.Enums.ImageryRendererType Type { get; }
Implements Type
Property Value
RasterStretchRenderer.UseGamma Property
Denotes whether the gamma value should be used.
public System.Nullable<bool> UseGamma { get; set; }
Property Value
System.Nullable<System.Boolean>
Methods
RasterStretchRenderer.AddToCustomStatistics(RasterBandStatistics[]) Method
Asynchronously adds elements to the CustomStatistics property.
public System.Threading.Tasks.Task AddToCustomStatistics(params dymaptic.GeoBlazor.Core.Model.RasterBandStatistics[] values);
Parameters
values RasterBandStatistics[]
The elements to add.
Returns
RasterStretchRenderer.AddToGamma(double[]) Method
Asynchronously adds elements to the Gamma property.
public System.Threading.Tasks.Task AddToGamma(params double[] values);
Parameters
values System.Double[]
The elements to add.
Returns
RasterStretchRenderer.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>
RasterStretchRenderer.GetComputeGamma() Method
Asynchronously retrieve the current value of the ComputeGamma property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetComputeGamma();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
RasterStretchRenderer.GetCustomStatistics() Method
Asynchronously retrieve the current value of the CustomStatistics property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.RasterBandStatistics>?> GetCustomStatistics();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<RasterBandStatistics>>
RasterStretchRenderer.GetDynamicRangeAdjustment() Method
Asynchronously retrieve the current value of the DynamicRangeAdjustment property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetDynamicRangeAdjustment();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
RasterStretchRenderer.GetGamma() Method
Asynchronously retrieve the current value of the Gamma property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<double>?> GetGamma();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<System.Double>>
RasterStretchRenderer.GetMaxPercent() Method
Asynchronously retrieve the current value of the MaxPercent property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetMaxPercent();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
RasterStretchRenderer.GetMinPercent() Method
Asynchronously retrieve the current value of the MinPercent property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetMinPercent();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
RasterStretchRenderer.GetNumberOfStandardDeviations() Method
Asynchronously retrieve the current value of the NumberOfStandardDeviations property.
public System.Threading.Tasks.Task<System.Nullable<int>> GetNumberOfStandardDeviations();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Int32>>
RasterStretchRenderer.GetOutputMax() Method
Asynchronously retrieve the current value of the OutputMax property.
public System.Threading.Tasks.Task<System.Nullable<int>> GetOutputMax();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Int32>>
RasterStretchRenderer.GetOutputMin() Method
Asynchronously retrieve the current value of the OutputMin property.
public System.Threading.Tasks.Task<System.Nullable<int>> GetOutputMin();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Int32>>
RasterStretchRenderer.GetSigmoidStrengthLevel() Method
Asynchronously retrieve the current value of the SigmoidStrengthLevel property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetSigmoidStrengthLevel();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
RasterStretchRenderer.GetStretchType() Method
Asynchronously retrieve the current value of the StretchType property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.StretchType>> GetStretchType();
Returns
System.Threading.Tasks.Task<System.Nullable<StretchType>>
RasterStretchRenderer.GetUseGamma() Method
Asynchronously retrieve the current value of the UseGamma property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetUseGamma();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
RasterStretchRenderer.RemoveFromCustomStatistics(RasterBandStatistics[]) Method
Asynchronously remove an element from the CustomStatistics property.
public System.Threading.Tasks.Task RemoveFromCustomStatistics(params dymaptic.GeoBlazor.Core.Model.RasterBandStatistics[] values);
Parameters
values RasterBandStatistics[]
The elements to remove.
Returns
RasterStretchRenderer.RemoveFromGamma(double[]) Method
Asynchronously remove an element from the Gamma property.
public System.Threading.Tasks.Task RemoveFromGamma(params double[] values);
Parameters
values System.Double[]
The elements to remove.
Returns
RasterStretchRenderer.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
RasterStretchRenderer.SetComputeGamma(Nullable) Method
Asynchronously set the value of the ComputeGamma property after render.
public System.Threading.Tasks.Task SetComputeGamma(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
RasterStretchRenderer.SetCustomStatistics(IReadOnlyList) Method
Asynchronously set the value of the CustomStatistics property after render.
public System.Threading.Tasks.Task SetCustomStatistics(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Model.RasterBandStatistics>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<RasterBandStatistics>
The value to set.
Returns
RasterStretchRenderer.SetDynamicRangeAdjustment(Nullable) Method
Asynchronously set the value of the DynamicRangeAdjustment property after render.
public System.Threading.Tasks.Task SetDynamicRangeAdjustment(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
RasterStretchRenderer.SetGamma(IReadOnlyList) Method
Asynchronously set the value of the Gamma property after render.
public System.Threading.Tasks.Task SetGamma(System.Collections.Generic.IReadOnlyList<double>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<System.Double>
The value to set.
Returns
RasterStretchRenderer.SetMaxPercent(Nullable) Method
Asynchronously set the value of the MaxPercent property after render.
public System.Threading.Tasks.Task SetMaxPercent(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
RasterStretchRenderer.SetMinPercent(Nullable) Method
Asynchronously set the value of the MinPercent property after render.
public System.Threading.Tasks.Task SetMinPercent(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
RasterStretchRenderer.SetNumberOfStandardDeviations(Nullable) Method
Asynchronously set the value of the NumberOfStandardDeviations property after render.
public System.Threading.Tasks.Task SetNumberOfStandardDeviations(System.Nullable<int> value);
Parameters
value System.Nullable<System.Int32>
The value to set.
Returns
RasterStretchRenderer.SetOutputMax(Nullable) Method
Asynchronously set the value of the OutputMax property after render.
public System.Threading.Tasks.Task SetOutputMax(System.Nullable<int> value);
Parameters
value System.Nullable<System.Int32>
The value to set.
Returns
RasterStretchRenderer.SetOutputMin(Nullable) Method
Asynchronously set the value of the OutputMin property after render.
public System.Threading.Tasks.Task SetOutputMin(System.Nullable<int> value);
Parameters
value System.Nullable<System.Int32>
The value to set.
Returns
RasterStretchRenderer.SetSigmoidStrengthLevel(Nullable) Method
Asynchronously set the value of the SigmoidStrengthLevel property after render.
public System.Threading.Tasks.Task SetSigmoidStrengthLevel(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
RasterStretchRenderer.SetStretchType(StretchType) Method
Updates the StretchType of the renderer after initial rendering.
public System.Threading.Tasks.Task SetStretchType(dymaptic.GeoBlazor.Core.Enums.StretchType stretchType);
Parameters
stretchType StretchType
Returns
RasterStretchRenderer.SetUseGamma(Nullable) Method
Asynchronously set the value of the UseGamma property after render.
public System.Threading.Tasks.Task SetUseGamma(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
RasterStretchRenderer.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()