ArcGIS Pro 3.7 API Reference Guide
ArcGIS.Desktop.Mapping Namespace / StretchColorizerDefinition Class / StretchColorizerDefinition Constructor / StretchColorizerDefinition Constructor()
Example

In This Topic
    StretchColorizerDefinition Constructor()
    In This Topic
    Creates a default Stretch colorizer definition.
    Syntax
    Public Function New()
    public StretchColorizerDefinition()
    Example
    Create a new colorizer based on a default colorizer definition and apply it to the raster layer
    {
        // Check if the Stretch colorizer can be applied to the raster layer.
        //Note: needs to be called on the QueuedTask
        if (rasterLayer.GetApplicableColorizers().Contains(RasterColorizerType.StretchColorizer))
        {
            // Create a new Stretch Colorizer Definition using the default constructor.
            StretchColorizerDefinition stretchColorizerDef_default = new StretchColorizerDefinition();
            // Create a new Stretch colorizer using the colorizer definition created above.
            CIMRasterStretchColorizer newStretchColorizer_default =
            await rasterLayer.CreateColorizerAsync(stretchColorizerDef_default) as CIMRasterStretchColorizer;
            // Set the new colorizer on the raster layer.
            rasterLayer.SetColorizer(newStretchColorizer_default);
        }
    }
    Create a raster layer with a new colorizer definition
    {
        // Create a new stretch colorizer definition using default constructor.
        StretchColorizerDefinition stretchColorizerDef = new StretchColorizerDefinition();
        // Create a raster layer creation parameters object with the raster file path.
        var rasterLayerCreationParams = new RasterLayerCreationParams(new Uri("rasterPath"))
        {
            ColorizerDefinition = stretchColorizerDef,
            Name = "rasterLayerName",
            MapMemberIndex = 0
        };
    
        // Create a raster layer using the colorizer definition created above.
        // Note: You can create a raster layer from a url, project item, or data connection.
        //Note: Run within a QueuedTask
        RasterLayer rasterLayerfromURL =
      LayerFactory.Instance.CreateLayer<RasterLayer>(rasterLayerCreationParams, map);
    
    }
    Create a new colorizer based on a default colorizer definition and apply it to the mosaic layer
    {
        // Get the image sub-layer from the mosaic layer.
        //Note: needs to be called on the QueuedTask
        ImageMosaicSubLayer mosaicImageSubLayer = mosaicLayer.GetImageLayer();
        // Check if the Stretch colorizer can be applied to the image sub-layer.
        if (mosaicImageSubLayer.GetApplicableColorizers().Contains(RasterColorizerType.StretchColorizer))
        {
            // Create a new Stretch Colorizer Definition using the default constructor.
            StretchColorizerDefinition stretchColorizerDef_default = new StretchColorizerDefinition();
            // Create a new Stretch colorizer using the colorizer definition created above.
            CIMRasterStretchColorizer newStretchColorizer_default =
        await mosaicImageSubLayer.CreateColorizerAsync(stretchColorizerDef_default) as CIMRasterStretchColorizer;
            // Set the new colorizer on the image sub-layer.
            mosaicImageSubLayer.SetColorizer(newStretchColorizer_default);
        }
    }
    Create a mosaic layer with a new colorizer definition
    // Create a new colorizer definition using default constructor.
    {
        StretchColorizerDefinition stretchColorizerDef = new StretchColorizerDefinition();
        var rasterLayerCreationParams = new RasterLayerCreationParams(new Uri("url"))
        {
            Name = "layerRasterName",
            ColorizerDefinition = stretchColorizerDef,
            MapMemberIndex = 0
    
        };
        // Create a mosaic layer using the colorizer definition created above.
        // Note: You can create a mosaic layer from a url, project item, or data connection.
        //Note: Run within a QueuedTask
        MosaicLayer newMosaicLayer = LayerFactory.Instance.CreateLayer<MosaicLayer>(rasterLayerCreationParams, map);
    }
    Create a new colorizer based on a default colorizer definition and apply it to the image service layer
    {
        // Check if the Stretch colorizer can be applied to the image service layer.
        if (imageServiceLayer.GetApplicableColorizers().Contains(RasterColorizerType.StretchColorizer))
        {
            // Create a new Stretch Colorizer Definition using the default constructor.
            StretchColorizerDefinition stretchColorizerDef_default = new StretchColorizerDefinition();
            // Create a new Stretch colorizer using the colorizer definition created above.
            CIMRasterStretchColorizer newStretchColorizer_default =
        await imageServiceLayer.CreateColorizerAsync(stretchColorizerDef_default) as CIMRasterStretchColorizer;
            // Set the new colorizer on the image service layer.
            imageServiceLayer.SetColorizer(newStretchColorizer_default);
        }
    }
    Create an image service layer with a new colorizer definition
    {
        // Create a new colorizer definition using default constructor.
        StretchColorizerDefinition stretchColorizerDef = new StretchColorizerDefinition();
        var rasterLayerCreationParams = new RasterLayerCreationParams(new Uri(url))
        {
            Name = "RasterLayer",
            ColorizerDefinition = stretchColorizerDef,
            MapMemberIndex = 0
        };
        // Create an image service layer using the colorizer definition created above.
        //Note: Run within a QueuedTask
        ImageServiceLayer imageServiceLayerWithColorizer =
      LayerFactory.Instance.CreateLayer<ImageServiceLayer>(rasterLayerCreationParams, map);
    }
    Requirements

    Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

    ArcGIS Pro version: 3.0 or higher.
    See Also