ImageMediaInfo | References | ArcGIS Maps SDK for JavaScript

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

Inheritance:: ImageMediaInfo→MediaInfo→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.11

An ImageMediaInfo is a type of media element that represents images to display within a popup.

popuptemplate-media-element-image

See also

Example

// Create the ImageMediaInfoValue
let imageMediaInfoValue = new ImageMediaInfoValue({
  sourceURL: "<insert URL>"
});

// Create the ImageMediaInfo
let imageElement = new ImageMediaInfo({
  title: "<b>Mexican Fan Palm</b>",
  caption: "tree species",
  value: imageMediaInfoValue
});

// Create the MediaContent
let mediaElement = new MediaContent({
  mediaInfos: [ imageElement ]
});

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`ImageMediaInfoProperties`

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
`refreshInterval`	`number`
`title` inherited	`string`	MediaInfo
`type` readonly	`"image"`
`value`	`ImageMediaInfoValue \| null \| undefined`

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.

refreshInterval

Property

Type: number

Refresh interval of the layer in minutes. Non-zero value indicates automatic layer refresh at the specified interval. Value of 0 indicates auto refresh is not enabled.

Default value: 0

title

inherited Property

Type: string

Inherited from: MediaInfo

The title of the media element.

Default value: ""

type

readonly Property

Type: "image"

The type of popup element.

Default value: "image"

value

autocast Property

Type: ImageMediaInfoValue | null | undefined

Defines the value format of the image media element and how the images should be retrieved.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone`	`clone(): ImageMediaInfo`
`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 (): ImageMediaInfo

Creates a deep clone of the ImageMediaInfo class.

Returns: ImageMediaInfo
A deep clone of the ImageMediaInfo 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.