renderers

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

A convenience module for importing Renderer classes when developing with TypeScript. For example, rather than importing renderers one at a time like this:

import ClassBreaksRenderer from "esri/renderers/ClassBreaksRenderer";
import HeatmapRenderer from "esri/renderers/HeatmapRenderer";
import SimpleRenderer from "esri/renderers/SimpleRenderer";
import UniqueValueRenderer from "esri/renderers/UniqueValueRenderer";
import DictionaryRenderer from "esri/renderers/DictionaryRenderer";

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

import { ClassBreaksRenderer, HeatmapRenderer, SimpleRenderer, UniqueValueRenderer } from "esri/renderers";

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

import { Renderer } from "esri/renderers";

function logRenderer(renderer: Renderer): void {
  if (renderer.type === "simple") {
    // new at 4.8, the compiler knows the renderer is a SimpleRenderer
    console.log("renderer symbol: ", renderer.symbol);
  }
  else {
    if (renderer.type !== "heatmap") {
      // the compiler knows the renderer must be a `ClassBreaksRenderer | UniqueValueRenderer`
      console.log("renderer background symbol: ", renderer.backgroundFillSymbol);
    }
  }
}

Type Definitions

ClassBreaksRenderer

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

ClassBreaksRenderer.

DictionaryRenderer

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

DictionaryRenderer.

DotDensityRenderer

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

DotDensityRenderer.

HeatmapRenderer

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

HeatmapRenderer.

PieChartRenderer

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

PieChartRenderer.

Renderer

Type Definition
Renderer HeatmapRenderer |RendererWithVisualVariables
Deprecated since version 4.32. Use RendererUnion instead.

Renderer.

RendererWithVisualVariables

Type Definition
RendererWithVisualVariables SimpleRenderer |ClassBreaksRenderer |UniqueValueRenderer |DotDensityRenderer |DictionaryRenderer |PieChartRenderer
Deprecated since version 4.32. Use RendererWithVisualVariablesUnion instead.

RendererWithVisualVariables.

SimpleRenderer

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

SimpleRenderer.

UniqueValueRenderer

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

UniqueValueRenderer.

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