Blazor

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SfSmithchart - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SfSmithchart

    Inheritance
    System.Object
    BaseComponent
    SfSmithchart
    Implements
    System.IDisposable
    ISmithchart
    Inherited Members
    BaseComponent.CreateJsAdaptor()
    BaseComponent.Dispose()
    BaseComponent.Refresh()
    BaseComponent.clearClientChanges(Boolean)
    BaseComponent.InvokeSet<T>(String, String, Object[])
    BaseComponent.InvokeGet<T>(String, String)
    BaseComponent.WireObservableEvents(Object)
    BaseComponent.getSerializedModel()
    BaseComponent.getUpdateModel(Boolean)
    BaseComponent.GetDataManager(Object, String)
    BaseComponent.uniqueId
    BaseComponent.jsRuntime
    BaseComponent.EditContext
    BaseComponent.mainParent
    BaseComponent.DotNetObjectRef
    Namespace: Syncfusion.Blazor.Charts
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class SfSmithchart : BaseComponent, IDisposable, ISmithchart

    Constructors

    SfSmithchart()

    Declaration
    public SfSmithchart()

    Properties

    Background

    The background color of the smithchart.

    Declaration
    public string Background { get; set; }
    Property Value
    Type Description
    System.String

    Border

    options for customizing border

    Declaration
    public SmithchartBorder Border { get; set; }
    Property Value
    Type Description
    SmithchartBorder

    ChildContent

    Declaration
    public RenderFragment ChildContent { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.RenderFragment

    ElementSpacing

    Spacing between elements

    Declaration
    public double ElementSpacing { get; set; }
    Property Value
    Type Description
    System.Double

    EnablePersistence

    Enable or disable persisting component's state between page reloads.

    Declaration
    public bool EnablePersistence { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnableRtl

    Enable or disable rendering component in right to left direction.

    Declaration
    public bool EnableRtl { get; set; }
    Property Value
    Type Description
    System.Boolean

    Font

    options for customizing margin

    Declaration
    public SmithchartFont Font { get; set; }
    Property Value
    Type Description
    SmithchartFont

    Height

    height for smithchart.

    Declaration
    public string Height { get; set; }
    Property Value
    Type Description
    System.String

    HorizontalAxis

    Options to configure the horizontal axis.

    Declaration
    public SmithchartHorizontalAxis HorizontalAxis { get; set; }
    Property Value
    Type Description
    SmithchartHorizontalAxis

    HtmlAttributes

    Declaration
    public Dictionary<string, object> HtmlAttributes { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.Dictionary<System.String, System.Object>

    ID

    Declaration
    public override string ID { get; set; }
    Property Value
    Type Description
    System.String
    Overrides
    Syncfusion.Blazor.BaseComponent.ID

    jsProperty

    Declaration
    protected override string jsProperty { get; set; }
    Property Value
    Type Description
    System.String
    Overrides
    BaseComponent.jsProperty

    LegendSettings

    options for customizing legend

    Declaration
    public SmithchartLegendSettings LegendSettings { get; set; }
    Property Value
    Type Description
    SmithchartLegendSettings

    Locale

    Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

    Declaration
    public string Locale { get; set; }
    Property Value
    Type Description
    System.String

    Margin

    options for customizing margin

    Declaration
    public SmithchartMargin Margin { get; set; }
    Property Value
    Type Description
    SmithchartMargin

    ModelType

    Declaration
    public override Type ModelType { get; set; }
    Property Value
    Type Description
    System.Type
    Overrides
    Syncfusion.Blazor.BaseComponent.ModelType

    nameSpace

    Declaration
    protected override string nameSpace { get; set; }
    Property Value
    Type Description
    System.String
    Overrides
    BaseComponent.nameSpace

    RadialAxis

    Options to configure the vertical axis.

    Declaration
    public SmithchartRadialAxis RadialAxis { get; set; }
    Property Value
    Type Description
    SmithchartRadialAxis

    Radius

    Spacing between elements

    Declaration
    public double Radius { get; set; }
    Property Value
    Type Description
    System.Double

    RenderType

    render type of smithchart.

    Declaration
    public RenderType RenderType { get; set; }
    Property Value
    Type Description
    RenderType

    Series

    options for customizing series

    Declaration
    public List<SmithchartSeries> Series { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<SmithchartSeries>

    Theme

    theme for smithchart.

    Declaration
    public SmithchartTheme Theme { get; set; }
    Property Value
    Type Description
    SmithchartTheme

    Title

    options for customizing title

    Declaration
    public SmithchartTitle Title { get; set; }
    Property Value
    Type Description
    SmithchartTitle

    Width

    width for smithchart.

    Declaration
    public string Width { get; set; }
    Property Value
    Type Description
    System.String

    Methods

    BuildRenderTree(RenderTreeBuilder)

    Declaration
    protected override void BuildRenderTree(RenderTreeBuilder __builder)
    Parameters
    Type Name Description
    Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

    Export(SmithchartExportType, String, Object)

    Handles the export method for chart control.

    Declaration
    public Task Export(SmithchartExportType type, string fileName, object orientation = null)
    Parameters
    Type Name Description
    SmithchartExportType type
    System.String fileName
    System.Object orientation
    Returns
    Type Description
    System.Threading.Tasks.Task

    GetJSNamespace()

    Declaration
    public string GetJSNamespace()
    Returns
    Type Description
    System.String

    GetModuleName()

    Get component name

    Declaration
    public Task<string> GetModuleName()
    Returns
    Type Description
    System.Threading.Tasks.Task<System.String>

    MouseEnd(Object)

    Declaration
    public Task MouseEnd(object e)
    Parameters
    Type Name Description
    System.Object e
    Returns
    Type Description
    System.Threading.Tasks.Task

    MouseMove(Object)

    Declaration
    public Task MouseMove(object e)
    Parameters
    Type Name Description
    System.Object e
    Returns
    Type Description
    System.Threading.Tasks.Task

    OnAfterRenderAsync(Boolean)

    Declaration
    protected override Task OnAfterRenderAsync(bool firstRender)
    Parameters
    Type Name Description
    System.Boolean firstRender
    Returns
    Type Description
    System.Threading.Tasks.Task
    Overrides
    BaseComponent.OnAfterRenderAsync(Boolean)

    OnInitializedAsync()

    Declaration
    protected override Task OnInitializedAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task
    Overrides
    BaseComponent.OnInitializedAsync()

    OnParametersSetAsync()

    Declaration
    protected override Task OnParametersSetAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task

    Print(Object)

    Declaration
    public Task Print(object id = null)
    Parameters
    Type Name Description
    System.Object id
    Returns
    Type Description
    System.Threading.Tasks.Task

    SmithchartOnClick(Object)

    To handle the click event for the smithchart.

    Declaration
    public Task SmithchartOnClick(object e)
    Parameters
    Type Name Description
    System.Object e
    Returns
    Type Description
    System.Threading.Tasks.Task

    SmithchartOnResize(EventArgs)

    To handle the window resize event on smithchart.

    Declaration
    public Task<bool> SmithchartOnResize(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e
    Returns
    Type Description
    System.Threading.Tasks.Task<System.Boolean>

    updateChildProperties(String, Object)

    Declaration
    public void updateChildProperties(string key, object value)
    Parameters
    Type Name Description
    System.String key
    System.Object value

    Implements

    System.IDisposable
    ISmithchart
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved