layout: default title: ImageMediaInfo parent: Core Classes —

dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components.Popups

ImageMediaInfo Class

An ImageMediaInfo is a type of media element that represents images to display within a popup.
ArcGIS Maps SDK for JavaScript

public class ImageMediaInfo : dymaptic.GeoBlazor.Core.Components.Popups.MediaInfo

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 MediaInfo 🡒 ImageMediaInfo

Constructors

ImageMediaInfo() Constructor

Parameterless constructor for use as a razor component.

public ImageMediaInfo();

ImageMediaInfo(string, string, string, ImageMediaInfoValue, Nullable) Constructor

Constructor for building a ImageMediaInfo in code.

public ImageMediaInfo(string? title=null, string? caption=null, string? altText=null, dymaptic.GeoBlazor.Core.Components.Popups.ImageMediaInfoValue? value=null, System.Nullable<double> refreshInterval=null);

Parameters

title System.String

The title of the media element.

caption System.String

Defines a caption for the media.

altText System.String

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

value ImageMediaInfoValue

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

refreshInterval System.Nullable<System.Double>

Refresh interval of the layer in minutes. Non-zero value indicates automatic layer refresh at the specified

Properties

ImageMediaInfo.AltText Property

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

public string? AltText { get; set; }

Property Value

System.String

ImageMediaInfo.Caption Property

Defines a caption for the media.

public string? Caption { get; set; }

Property Value

System.String

ImageMediaInfo.RefreshInterval Property

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. If the property does not exist, it is equivalent to
having a value of 0.

public System.Nullable<double> RefreshInterval { get; set; }

Property Value

System.Nullable<System.Double>

ImageMediaInfo.Title Property

The title of the media element.

public string? Title { get; set; }

Property Value

System.String

ImageMediaInfo.Type Property

Indicates the type of media

public override string Type { get; }

Property Value

System.String

ImageMediaInfo.Value Property

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

public dymaptic.GeoBlazor.Core.Components.Popups.ImageMediaInfoValue? Value { get; set; }

Property Value

ImageMediaInfoValue

Methods

ImageMediaInfo.RegisterChildComponent(MapComponent) Method

Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnInitializedAsync to “Register” the current component with it’s parent.

public override System.Threading.Tasks.Task RegisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);

Parameters

child MapComponent

The calling, child component to register

Returns

System.Threading.Tasks.Task

Exceptions

InvalidChildElementException
Throws if the current child is not a valid sub-component to the parent.

Remarks

This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method. If you see no other way to register a child component, please open an issue on GitHub.

ImageMediaInfo.UnregisterChildComponent(MapComponent) Method

Undoes the “Registration” of a child with its parent.

public override System.Threading.Tasks.Task UnregisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);

Parameters

child MapComponent

The child to unregister

Returns

System.Threading.Tasks.Task

Remarks

This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method.