BarChartMediaInfo

AMD: require(["esri/popup/content/BarChartMediaInfo"], (BarChartMediaInfo) => { /* code goes here */ });
ESM: import BarChartMediaInfo from "@arcgis/core/popup/content/BarChartMediaInfo";
Class: esri/popup/content/BarChartMediaInfo
Inheritance: BarChartMediaInfo Accessor
Since: ArcGIS API for JavaScript 4.11

A BarChartMediaInfo is a type of chart media element that represents a bar chart displayed within a popup.

popuptemplate-media-barchart

See also:
Example:
// Create a new BarChart to display within the PopupTemplate
// Create the ChartMediaInfoValue
let barChartValue = new ChartMediaInfoValue({
  fields: ["<array of strings indicating fields>"],
  normalizeField: null,
  tooltipField: "<field name>"
});

// Create the BarChartMediaInfo media type
let barChart = new BarChartMediaInfo({
  title: "<b>Count by type</b>",
  caption: "Per block",
  value: barChartValue
});

// Create the Media Content Element
let mediaElement = new MediaContent({
  mediaInfos: [barChart]
});

Constructors

new BarChartMediaInfo(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

Provides an alternate text for an image if the image cannot be displayed.

more detailsBarChartMediaInfo
Stringmore details

Defines a caption for the media.

more detailsBarChartMediaInfo
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

The title of the media element.

more detailsBarChartMediaInfo
Stringmore details

Indicates the type of chart.

more detailsBarChartMediaInfo
ChartMediaInfoValuemore details

Defines the chart value.

more detailsBarChartMediaInfo

Property Details

altText String
Since: ArcGIS API for JavaScript 4.16

Provides an alternate text for an image if the image cannot be displayed.

caption String

Defines a caption for the media.

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

title String

The title of the media element.

type Stringreadonly

Indicates the type of chart.

Default Value:bar-chart

Defines the chart value.

Method Overview

Name Return Type Summary Class
BarChartMediaInfomore details

Creates a deep clone of the BarChartMediaInfo class.

more detailsBarChartMediaInfo
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsBarChartMediaInfo
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsBarChartMediaInfo

Method Details

Creates a deep clone of the BarChartMediaInfo class.

Returns:
Type Description
BarChartMediaInfo A deep clone of the BarChartMediaInfo instance.
fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
Type Description
* Returns a new instance of this class.
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

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