Search results

Smithchart

Represents the Smithchart control.

<div id="smithchart"/>
<script>
  var chartObj = new Smithchart({ isResponsive : true });
  chartObj.appendTo("#smithchart");
</script>

Properties

background

string

The background color of the smithchart.

border

SmithchartBorderModel

options for customizing border.

bounds

SmithchartRect

area bounds

elementSpacing

number

Spacing between elements.

Defaults to 10

enablePersistence

boolean

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

Defaults to false

enableRtl

boolean

Enable or disable rendering component in right to left direction.

Defaults to false

font

SmithchartFontModel

options for customizing margin.

height

string

height for smithchart.

Defaults to

horizontalAxis

SmithchartAxisModel

Options to configure the horizontal axis.

legendBounds

SmithchartRect

legend bounds

legendSettings

SmithchartLegendSettingsModel

options for customizing legend.

locale

string

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

Defaults to

margin

SmithchartMarginModel

options for customizing margin.

radialAxis

SmithchartAxisModel

Options to configure the vertical axis.

radius

number

Spacing between elements.

Defaults to 1

renderType

RenderType

render type of smithchart.

Defaults to Impedance

series

SmithchartSeriesModel[]

options for customizing series.

smithchartLegendModule

SmithchartLegend

smithchartLegendModule is used to add legend to the smithchart.

theme

SmithchartTheme

theme for smithchart.

Defaults to Material

title

TitleModel

options for customizing title.

tooltipRenderModule

TooltipRender

tooltipRenderModule is used to add tooltip to the smithchart.

width

string

width for smithchart.

Defaults to

Methods

addEventListener

Adds the handler to the given event listener.

Parameter Type Description
eventName string A String that specifies the name of the event
handler Function Specifies the call to run when the event occurs.

Returns void

appendTo

Appends the control within the given HTML element

Parameter Type Description
selector (optional) string | HTMLElement Target element where control needs to be appended

Returns void

attachUnloadEvent

Adding unload event to persist data when enable persistence true

Returns void

dataBind

When invoked, applies the pending property changes immediately to the component.

Returns void

destroy

To destroy the widget.

Returns void

detachUnloadEvent

Removing unload event to persist data when enable persistence true

Returns void

export

Handles the export method for the smith chart control.

Parameter Type Description
type SmithchartExportType The smith chart export type.
fileName string The filename of the exported smith chart.
orientation (optional) PdfPageOrientation The page orientation for PDF export.

Returns void

getLocalData

Returns the persistence data for component

Returns any

getModuleName

Get component name.

Returns string

getRootElement

Returns the route element of the component

Returns HTMLElement

handleUnload

Handling unload event to persist data when enable persistence true

Returns void

refresh

Applies all the pending property changes and render the component again.

Returns void

removeEventListener

Removes the handler from the given event listener.

Parameter Type Description
eventName string A String that specifies the name of the event to remove
handler Function Specifies the function to remove

Returns void

smithchartOnClick

To handle the click event for the smithchart.

Parameter Type Description
e Event | PointerEvent The event.

Returns void

smithchartOnResize

To handle the window resize event on smithchart.

Returns boolean

Inject

Dynamically injects the required modules to the component.

Parameter Type Description
moduleList Function[] ?

Returns void

Events

animationComplete

EmitType<ISmithchartAnimationCompleteEventArgs>

Triggers after the animation completed.

axisLabelRender

EmitType<ISmithchartAxisLabelRenderEventArgs>

Triggers before the axis label is rendered.

beforePrint

EmitType<ISmithchartPrintEventArgs>

Triggers before the prints gets started.

legendRender

EmitType<ISmithchartLegendRenderEventArgs>

Triggers before the legend is rendered.

load

EmitType<ISmithchartLoadEventArgs>

Triggers before smithchart rendered.

loaded

EmitType<ISmithchartLoadedEventArgs>

Triggers after smithchart rendered.

seriesRender

EmitType<ISmithchartSeriesRenderEventArgs>

Triggers before the series is rendered.

subtitleRender

EmitType<ISubTitleRenderEventArgs>

Triggers before the sub-title is rendered.

textRender

EmitType<ISmithchartTextRenderEventArgs>

Triggers before the datalabel text is rendered.

titleRender

EmitType<ITitleRenderEventArgs>

Triggers before the title is rendered.

tooltipRender

EmitType<ISmithChartTooltipEventArgs>

Triggers before the tooltip rendering.