rasterRenderers

AMD: require(["esri/rasterRenderers"], (rasterRenderers) => { /* code goes here */ });
ESM: import * as rasterRenderers from "@arcgis/core/rasterRenderers.js";
Object: esri/rasterRenderers
Since: ArcGIS Maps SDK for JavaScript 4.13
Deprecated since version 4.32. Use unionTypes to import union types, or individual modules to import classes.

A convenience module for importing renderer classes that can be used to render ImageryLayer when developing with TypeScript. For example, rather than importing renderers one at a time like this:

import FlowRenderer from "esri/renderers/FlowRenderer";
import ClassBreaksRenderer from "esri/renderers/ClassBreaksRenderer";
import UniqueValueRenderer from "esri/renderers/UniqueValueRenderer";
import RasterStretchRenderer from "esri/renderers/RasterStretchRenderer";
import RasterColormapRenderer from "esri/renderers/RasterColormapRenderer";
import RasterShadedReliefRenderer from "esri/renderers/RasterShadedReliefRenderer";
import VectorFieldRenderer from "esri/renderers/VectorFieldRenderer";

You can use this module to import them on a single line:

import { FlowRenderer, ClassBreaksRenderer, UniqueValueRenderer, RasterColormapRenderer, RasterStretchRenderer, RasterShadedReliefRenderer, VectorFieldRenderer } from "esri/rasterRenderers";

This module also allows you to implement type guards on renderers, making your code smarter.

import { Renderer } from "esri/rasterRenderers";

function logRenderer(renderer: RasterStretchRenderer): void {
 if (renderer.type == "raster-stretch") {
   // the compiler knows the renderer must be a RasterStretchRenderer
   console.log("renderer color ramp: ", renderer.colorRamp);
 }
}

Type Definitions

ClassBreaksRenderer

Type Definition
ClassBreaksRenderer ClassBreaksRenderer
Deprecated since version 4.32. Import ClassBreaksRenderer directly instead.

ClassBreaksRenderer.

FlowRenderer

Type Definition
FlowRenderer FlowRenderer
Deprecated since version 4.32. Import FlowRenderer directly instead.

FlowRenderer.

RasterColormapRenderer

Type Definition
RasterColormapRenderer RasterColormapRenderer
Deprecated since version 4.32. Import ClassBreaksRenderer directly instead.

RasterColormapRenderer.

RasterShadedReliefRenderer

Type Definition
RasterShadedReliefRenderer RasterShadedReliefRenderer
Deprecated since version 4.32. Import RasterShadedReliefRenderer directly instead.

RasterShadedReliefRenderer.

RasterStretchRenderer

Type Definition
RasterStretchRenderer RasterStretchRenderer
Deprecated since version 4.32. Import RasterStretchRenderer directly instead.

RasterStretchRenderer.

UniqueValueRenderer

Type Definition
UniqueValueRenderer UniqueValueRenderer
Deprecated since version 4.32. Import UniqueValueRenderer directly instead.

UniqueValueRenderer.

VectorFieldRenderer

Type Definition
VectorFieldRenderer VectorFieldRenderer
Deprecated since version 4.32. Import ClassBreaksRenderer directly instead.

VectorFieldRenderer.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close