Class MapsSubtitleSettings
Sets and gets the subtitle to be displayed for maps.
Inherited Members
Namespace: Syncfusion.Blazor.Maps
Assembly: Syncfusion.Blazor.dll
Syntax
public class MapsSubtitleSettings : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Constructors
MapsSubtitleSettings()
Declaration
public MapsSubtitleSettings()
Properties
Alignment
Gets or sets the alignment of the subtitle for maps.
Declaration
[Parameter]
public Alignment Alignment { get; set; }
Property Value
| Type | Description |
|---|---|
| Alignment | An Alignment enumeration value that specifies the alignment of the subtitle text. The default is Center. |
Remarks
This property determines the positioning of the subtitle text relative to the map.
ChildContent
Gets or sets the content of the UI element.
Declaration
[Parameter]
public RenderFragment ChildContent { get; set; }
Property Value
| Type | Description |
|---|---|
| RenderFragment | A RenderFragment that represents the content of the UI element for the maps subtitle. |
Remarks
Use this property to define custom content within the subtitle settings.
Description
Gets or sets the description of the subtitle in maps.
Declaration
[Parameter]
public string Description { get; set; }
Property Value
| Type | Description |
|---|---|
| string | A string representing the detailed description behind the subtitle. |
Remarks
This property is useful for accessibility purposes or when additional information about the subtitle is needed.
Text
Gets or sets the text for the subtitle in maps.
Declaration
[Parameter]
public string Text { get; set; }
Property Value
| Type | Description |
|---|---|
| string | A string specifying the text content of the subtitle. |
Remarks
This is the main content of the subtitle that appears below the map title.
Methods
BuildRenderTree(RenderTreeBuilder)
Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
| Type | Name | Description |
|---|---|---|
| RenderTreeBuilder | __builder |
Overrides
Dispose(bool)
Disposes the property values during the destroy of the component that is hold up for the execution of the component.
Declaration
protected override void Dispose(bool disposing)
Parameters
| Type | Name | Description |
|---|---|---|
| bool | disposing |
Overrides
OnInitializedAsync()
OnInitializedAsync method is called when the component has received its initial parameters.
Declaration
protected override Task OnInitializedAsync()
Returns
| Type | Description |
|---|---|
| Task | Task representing the asynchronous operation. |
Overrides
OnParametersSetAsync()
OnParametersSetAsync is a lifecycle method that is invoked when the component has received parameters, and the incoming values have been assigned to the properties.
Declaration
protected override Task OnParametersSetAsync()
Returns
| Type | Description |
|---|---|
| Task | Task representing the asynchronous operation. |