require(["esri/popup/content/ColumnChartMediaInfo"], (ColumnChartMediaInfo) => { /* code goes here */ });
import ColumnChartMediaInfo from "@arcgis/core/popup/content/ColumnChartMediaInfo.js";
esri/popup/content/ColumnChartMediaInfo
A ColumnChartMediaInfo
is a type of chart media element
that represents a column chart displayed within a popup.
- See also
// Create a new ColumnChart to display within the PopupTemplate
// Create the ChartMediaInfoValue
let columnChartValue = new ChartMediaInfoValue({
colors: [[220, 123, 4, 1], [229, 80, 53, 1], ...],
fields: ["<array of strings indicating fields>"],
normalizeField: null,
tooltipField: "<field name>"
});
// Create the ColumnChartMediaInfo media type
let columnChart = new ColumnChartMediaInfo({
title: "<b>Count by type</b>",
caption: "Per block",
value: columnChartValue
});
// Create the MediaContent
let mediaElement = new MediaContent({
mediaInfos: [columnChart]
});
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
Provides an alternate text for an image if the image cannot be displayed. | ColumnChartMediaInfo | ||
Defines a caption for the media. | ColumnChartMediaInfo | ||
The title of the media element. | ColumnChartMediaInfo | ||
Indicates the type of chart. | ColumnChartMediaInfo | ||
Defines the chart value. | ColumnChartMediaInfo |
Property Details
-
altText
altText String
Since: ArcGIS Maps SDK for JavaScript 4.16ColumnChartMediaInfo since 4.11, altText added at 4.16. -
Provides an alternate text for an image if the image cannot be displayed.
-
caption
caption String
-
Defines a caption for the media.
-
title
title String
-
The title of the media element.
-
type
type Stringreadonly
-
Indicates the type of chart.
- Default Value:"column-chart"
-
value
value ChartMediaInfoValueautocast
-
Defines the chart value.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Creates a deep clone of the ColumnChartMediaInfo class. | ColumnChartMediaInfo | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | ColumnChartMediaInfo | |
Converts an instance of this class to its ArcGIS portal JSON representation. | ColumnChartMediaInfo |
Method Details
-
clone
clone(){ColumnChartMediaInfo}
-
Creates a deep clone of the ColumnChartMediaInfo class.
ReturnsType Description ColumnChartMediaInfo A deep clone of the ColumnChartMediaInfo instance.
-
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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
toJSON
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.