Skip To ContentArcGIS for DevelopersSign In Dashboard

ColumnChartMediaInfo

require(["esri/popup/content/ColumnChartMediaInfo"], function(ColumnChartMediaInfo) { /* code goes here */ });
Class: esri/popup/content/ColumnChartMediaInfo
Since: ArcGIS API for JavaScript 4.11

A ColumnChartMediaInfo is a type of chart media element that represents a column chart displayed within a popup.

popuptemplate-media-columnchart

See also:
Example:
// Create a new ColumnChart to display within the PopupTemplate
// Create the ChartMediaInfoValue
let columnChartValue = new ChartMediaInfoValue({
  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

new ColumnChartMediaInfo(properties)
Parameter:
properties Object
optional

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

Property Overview

NameTypeSummaryClass
String

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

more details
more detailsColumnChartMediaInfo
String

Defines a caption for the media.

more details
more detailsColumnChartMediaInfo
String

The title of the media element.

more details
more detailsColumnChartMediaInfo
String

Indicates the type of chart.

more details
more detailsColumnChartMediaInfo
ChartMediaInfoValue

Defines the chart value.

more details
more detailsColumnChartMediaInfo

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.

title String

The title of the media element.

type Stringreadonly

Indicates the type of chart.

Default Value:column-chart

Defines the chart value.

Method Overview

NameReturn TypeSummaryClass
ColumnChartMediaInfo

Creates a deep clone of the ColumnChartMediaInfo class.

more details
more detailsColumnChartMediaInfo
*

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

more details
more detailsColumnChartMediaInfo
Object

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

more details
more detailsColumnChartMediaInfo

Method Details

Creates a deep clone of the ColumnChartMediaInfo class.

Returns:
TypeDescription
ColumnChartMediaInfoA deep clone of the ColumnChartMediaInfo instance.
fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. 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:
TypeDescription
*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:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule
Loading...