ColumnChartMediaInfo | References | ArcGIS Maps SDK for JavaScript

import ColumnChartMediaInfo from "@arcgis/core/popup/content/ColumnChartMediaInfo.js";

Inheritance:: ColumnChartMediaInfo→ChartMediaInfo→MediaInfo→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.11

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

popuptemplate-media-element-columnchart

See also

Example

// 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

Constructor

Parameters

Parameter	Type	Description	Required
properties	`ColumnChartMediaInfoProperties`

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`altText` inherited	`string \| null \| undefined`	MediaInfo
`caption` inherited	`string`	MediaInfo
`declaredClass` readonly inherited	`string`	Accessor
`title` inherited	`string`	MediaInfo
`type` readonly	`"column-chart"`
`value` inherited	`ChartMediaInfoValue \| null \| undefined`	ChartMediaInfo

altText

inherited Property

Type: string | null | undefined

Inherited from: MediaInfo

Since: ArcGIS Maps SDK for JavaScript 4.16

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

caption

inherited Property

Type: string

Inherited from: MediaInfo

Defines a caption for the media.

Default value: ""

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

title

inherited Property

Type: string

Inherited from: MediaInfo

The title of the media element.

Default value: ""

type

readonly Property

Type: "column-chart"

Indicates the type of chart.

Default value: "column-chart"

value

autocast inherited Property

Type: ChartMediaInfoValue | null | undefined

Inherited from: ChartMediaInfo

Defines the chart value.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone`	`clone(): ColumnChartMediaInfo`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

clone

Method

Signature: clone (): ColumnChartMediaInfo

Creates a deep clone of the ColumnChartMediaInfo class.

Returns: ColumnChartMediaInfo
A deep clone of the ColumnChartMediaInfo instance.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.