dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Popups
MediaPopupContent Class
A MediaContent popup element contains an individual or array of chart and/or image media elements
to display within a popup’s content.
ArcGIS Maps SDK for JavaScript
public class MediaPopupContent : dymaptic.GeoBlazor.Core.Components.Popups.PopupContent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 PopupContent 🡒 MediaPopupContent
Constructors
MediaPopupContent() Constructor
Parameterless constructor for use as a Razor Component.
public MediaPopupContent();
MediaPopupContent(string, string, IReadOnlyList, Nullable) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public MediaPopupContent(string? title=null, string? description=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.MediaInfo>? mediaInfos=null, System.Nullable<int> activeMediaInfoIndex=null);
Parameters
title System.String
Heading indicating what the media’s content represents.
ArcGIS Maps SDK for JavaScript
description System.String
Describes the media’s content in detail.
ArcGIS Maps SDK for JavaScript
mediaInfos System.Collections.Generic.IReadOnlyList<MediaInfo>
Contains the media elements representing images or charts to display
within the PopupTemplate.
ArcGIS Maps SDK for JavaScript
activeMediaInfoIndex System.Nullable<System.Int32>
Index of the current active media within the popup’s media content.
ArcGIS Maps SDK for JavaScript
Properties
MediaPopupContent.ActiveMediaInfoIndex Property
Index of the current active media within the popup’s media content. This will be the media that is currently viewed when displayed.
public System.Nullable<int> ActiveMediaInfoIndex { get; set; }
Property Value
MediaPopupContent.Description Property
Describes the media’s content in detail.
public string? Description { get; set; }
Property Value
MediaPopupContent.MediaInfos Property
Contains the media elements representing images or charts to display within the PopupTemplate.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.MediaInfo>? MediaInfos { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<MediaInfo>
MediaPopupContent.Title Property
Heading indicating what the media’s content represents.
public string? Title { get; set; }
Property Value
MediaPopupContent.Type Property
The type of Popup Content
public override dymaptic.GeoBlazor.Core.Enums.PopupContentType Type { get; }
Property Value
Methods
MediaPopupContent.AddToMediaInfos(MediaInfo[]) Method
Asynchronously adds elements to the MediaInfos property.
public System.Threading.Tasks.Task AddToMediaInfos(params dymaptic.GeoBlazor.Core.Components.MediaInfo[] values);
Parameters
The elements to add.
Returns
MediaPopupContent.GetActiveMediaInfoIndex() Method
Asynchronously retrieve the current value of the ActiveMediaInfoIndex property.
public System.Threading.Tasks.Task<System.Nullable<int>> GetActiveMediaInfoIndex();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Int32>>
MediaPopupContent.GetDescription() Method
Asynchronously retrieve the current value of the Description property.
public System.Threading.Tasks.Task<string?> GetDescription();
Returns
System.Threading.Tasks.Task<System.String>
MediaPopupContent.GetMediaInfos() Method
Asynchronously retrieve the current value of the MediaInfos property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.MediaInfo>?> GetMediaInfos();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<MediaInfo>>
MediaPopupContent.GetTitle() Method
Asynchronously retrieve the current value of the Title property.
public System.Threading.Tasks.Task<string?> GetTitle();
Returns
System.Threading.Tasks.Task<System.String>
MediaPopupContent.RegisterChildComponent(MapComponent) Method
Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnInitializedAsync to “Register” the current component with its parent.
public override System.Threading.Tasks.Task RegisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);
Parameters
child MapComponent
The calling, child component to register
Returns
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.
MediaPopupContent.RemoveFromMediaInfos(MediaInfo[]) Method
Asynchronously remove an element from the MediaInfos property.
public System.Threading.Tasks.Task RemoveFromMediaInfos(params dymaptic.GeoBlazor.Core.Components.MediaInfo[] values);
Parameters
The elements to remove.
Returns
MediaPopupContent.SetActiveMediaInfoIndex(Nullable) Method
Asynchronously set the value of the ActiveMediaInfoIndex property after render.
public System.Threading.Tasks.Task SetActiveMediaInfoIndex(System.Nullable<int> value);
Parameters
value System.Nullable<System.Int32>
The value to set.
Returns
MediaPopupContent.SetDescription(string) Method
Asynchronously set the value of the Description property after render.
public System.Threading.Tasks.Task SetDescription(string? value);
Parameters
value System.String
The value to set.
Returns
MediaPopupContent.SetMediaInfos(IReadOnlyList) Method
Asynchronously set the value of the MediaInfos property after render.
public System.Threading.Tasks.Task SetMediaInfos(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.MediaInfo>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<MediaInfo>
The value to set.
Returns
MediaPopupContent.SetTitle(string) Method
Asynchronously set the value of the Title property after render.
public System.Threading.Tasks.Task SetTitle(string? value);
Parameters
value System.String
The value to set.
Returns
MediaPopupContent.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
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.