Generates an RGB RasterStretchRenderer to render three selected bands into red, green, and blue color channels.more details
Generates an RGB RasterStretchRenderer to render three selected bands into red, green, and blue color channels.ParametersSpecificationparams Object
Input parameters for generating a RGB stretch visualization. See the table below for details of each parameter. The
dynamicRangeAdjustmentparameters are not related to RGB band ID selection or stretch type. Pass them in to preserve the existing settings if desired.Specification
The input layer for which the renderer is generated.renderingRule RasterFunctionoptional
Specifies the rule for how the requested image should be rendered. When
renderingRuleis applied, the server returns updated service information that reflects custom processing as defined by the rendering rule. If not provided, the output renderer is created using the layer's
A preferred stretch type can be provided. See RasterStretchRenderer.stretchType for more information.
The RGB band indexes following the order of red, green, and blue channels. This array must have three numbers.
The gamma values to be used if
true. Gamma refers to the degree of contrast between the mid-level gray values of a raster dataset. It does not affect black or white values, only the middle values. By applying a gamma correction, you can control the overall brightness of an ImageryLayer. Gamma stretching is only valid when
min-max. See RasterStretchRenderer.gamma for more information.useGamma Booleanoptional
Indicates whether the
gammavalues should be used. When
false, the gamma is calculated from the statistics and histogram of the data.dynamicRangeAdjustment Booleanoptional
true, calculates the renderer's statistics based on the current display extent and recalculates them as you zoom and pan around the image.estimateStatistics Booleanoptional
Useful in scenarios where an image service does not have statistics. When
true, this function estimates global statistics to keep a constant visual on pan and zoom, unlike
dynamicRangeAdjustmentwhich recalculates statistics on each extent change.signal AbortSignaloptional
Allows for cancelable requests. If canceled, the promise will be rejected with an error named
AbortError. See also AbortController.Returns
Type Description Promise<RasterRGBResult> Resolves to an object containing a stretch renderer that can be set on the input renderer.
The result object of the createRenderer() method. See the table below for details of each property.
The RGB RasterStretchRenderer renderer to apply to the input layer.
The RGB band indexes following the order of red, green, and blue channels.