Skip to main content
View as Markdown

IChart interface

No description yet.

public interface IChart : IPrimitive

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Inherits: IPrimitive

Properties​

PropertyTypeAccessDescription
AcRmsboolget; set
ActiveCursorIndexintget; set
ActivePlotIPlotget; set
ActivePlotIndexintget
ActiveWaveIPlottedWaveget; set
AutoMarginsboolget; set
AutoXDivboolget; set
AutoXMaxboolget; set
AutoXMinboolget; set
Averageboolget; set
BminusAboolget; set
ChartOptionsIChartOptionsget
ChartTitleIChartTitleget
ChartTypeTSimViewChartTypeget; set
ComplexYboolget; set
CurrentXValdoubleget; set
CursorAWaveOnPlotboolget
CursorBWaveOnPlotboolget
CursorCountintget
CursorInterfaceIMeasurementCursorget; set
DeltaItemTDeltaTypeget; set
DisplayMeasurementsboolget; set
DocumentOptionsIDocumentOptionsget
FourierFlagboolget; set
Frequencyboolget; set
GridDivWidthintget; set
GridLeftintget; set
GridRightintget; set
GridWidthintget
InitializeXNeededboolget; set
IsMetafileboolget; set
IsPrintingboolget; set
IsXAxisInDefaultStateboolget
IsYComplexboolget
LeftMarginintget; set
LogScaleBaseintget; set
Maximumboolget; set
Minimumboolget; set
Namestringget; set
PainterIPainterget
ParentIChartCollectionget
PlotIPlotget
PlotCountintget
PlotIndexByPlotintget
PlotsPerPrintedPageintget; set
PlottedWaveCountintget
PrimaryYDataTypeTDataTypeget; set
RestoredFlagboolget; set
RightMarginintget; set
RMSboolget; set
SimRunningboolget; set
SourceWaveISourceWaveget
SourceWaveByNameISourceWaveget
SourceWaveCountintget
SourceWaveIndexByNameintget
Titlestringget; set
TopIndexintget; set
TopPlotIPlotget
UpdateFilteredStatusboolget; set
UseInitialXMinMaxboolget; set
ViewTChartViewget
VisiblePlotsintget; set
WaveLabelFieldWidthintget
XAxisLabelstringget; set
XDataTypeTDataTypeget; set
XDivisionsintget; set
XDivSizedoubleget; set
XMaxdoubleget; set
XMindoubleget; set
XOffsetdoubleget; set
XScaleFieldWidthintget
XScaleModeTScaleModeget; set
XUnitsstringget; set
XYboolget; set
YScaleFieldWidthintget
YScaleModeTScaleModeget; set

AcRms​

No description yet.

bool GetProperty_AcRms();
void SetProperty_AcRms(bool argValue);

Type: bool · Access: read/write

ActiveCursorIndex​

No description yet.

int GetProperty_ActiveCursorIndex();
void SetProperty_ActiveCursorIndex(int argValue);

Type: int · Access: read/write

ActivePlot​

No description yet.

IPlot GetProperty_ActivePlot();
void SetProperty_ActivePlot(IPlot argValue);

Type: IPlot · Access: read/write

The accessors are extension methods of IChartHelper (using SCH;).

ActivePlotIndex​

No description yet.

int GetProperty_ActivePlotIndex();

Type: int · Access: read-only

ActiveWave​

No description yet.

IPlottedWave GetProperty_ActiveWave();
void SetProperty_ActiveWave(IPlottedWave argValue);

Type: IPlottedWave · Access: read/write

The accessors are extension methods of IChartHelper (using SCH;).

AutoMargins​

No description yet.

bool GetProperty_AutoMargins();
void SetProperty_AutoMargins(bool argValue);

Type: bool · Access: read/write

AutoXDiv​

No description yet.

bool GetProperty_AutoXDiv();
void SetProperty_AutoXDiv(bool argValue);

Type: bool · Access: read/write

AutoXMax​

No description yet.

bool GetProperty_AutoXMax();
void SetProperty_AutoXMax(bool argValue);

Type: bool · Access: read/write

AutoXMin​

No description yet.

bool GetProperty_AutoXMin();
void SetProperty_AutoXMin(bool argValue);

Type: bool · Access: read/write

Average​

No description yet.

bool GetProperty_Average();
void SetProperty_Average(bool argValue);

Type: bool · Access: read/write

BminusA​

No description yet.

bool GetProperty_BminusA();
void SetProperty_BminusA(bool argValue);

Type: bool · Access: read/write

ChartOptions​

No description yet.

IChartOptions GetProperty_ChartOptions();

Type: IChartOptions · Access: read-only

The accessors are extension methods of IChartHelper (using SCH;).

ChartTitle​

No description yet.

IChartTitle GetProperty_ChartTitle();

Type: IChartTitle · Access: read-only

The accessors are extension methods of IChartHelper (using SCH;).

ChartType​

No description yet.

TSimViewChartType GetProperty_ChartType();
void SetProperty_ChartType(TSimViewChartType argValue);

Type: TSimViewChartType · Access: read/write

The accessors are extension methods of IChartHelper (using SCH;).

ComplexY​

No description yet.

bool GetProperty_ComplexY();
void SetProperty_ComplexY(bool argValue);

Type: bool · Access: read/write

CurrentXVal​

No description yet.

double GetProperty_CurrentXVal();
void SetProperty_CurrentXVal(double argValue);

Type: double · Access: read/write

CursorAWaveOnPlot​

No description yet.

bool GetProperty_CursorAWaveOnPlot(IPlot argPlot);

Type: bool · Access: read-only · Index: argPlot (IPlot)

The accessors are extension methods of IChartHelper (using SCH;).

CursorBWaveOnPlot​

No description yet.

bool GetProperty_CursorBWaveOnPlot(IPlot argPlot);

Type: bool · Access: read-only · Index: argPlot (IPlot)

The accessors are extension methods of IChartHelper (using SCH;).

CursorCount​

No description yet.

int GetProperty_CursorCount();

Type: int · Access: read-only

CursorInterface​

No description yet.

IMeasurementCursor GetProperty_CursorInterface(int argIndex);
void SetProperty_CursorInterface(int argIndex, IMeasurementCursor argCursor);

Type: IMeasurementCursor · Access: read/write · Index: argIndex (int)

The accessors are extension methods of IChartHelper (using SCH;).

DeltaItem​

No description yet.

TDeltaType GetProperty_DeltaItem();
void SetProperty_DeltaItem(TDeltaType argValue);

Type: TDeltaType · Access: read/write

The accessors are extension methods of IChartHelper (using SCH;).

DisplayMeasurements​

No description yet.

bool GetProperty_DisplayMeasurements();
void SetProperty_DisplayMeasurements(bool argValue);

Type: bool · Access: read/write

DocumentOptions​

No description yet.

IDocumentOptions GetProperty_DocumentOptions();

Type: IDocumentOptions · Access: read-only

The accessors are extension methods of IChartHelper (using SCH;).

FourierFlag​

No description yet.

bool GetProperty_FourierFlag();
void SetProperty_FourierFlag(bool argValue);

Type: bool · Access: read/write

Frequency​

No description yet.

bool GetProperty_Frequency();
void SetProperty_Frequency(bool argValue);

Type: bool · Access: read/write

GridDivWidth​

No description yet.

int GetProperty_GridDivWidth();
void SetProperty_GridDivWidth(int argValue);

Type: int · Access: read/write

GridLeft​

No description yet.

int GetProperty_GridLeft();
void SetProperty_GridLeft(int argValue);

Type: int · Access: read/write

GridRight​

No description yet.

int GetProperty_GridRight();
void SetProperty_GridRight(int argValue);

Type: int · Access: read/write

GridWidth​

No description yet.

int GetProperty_GridWidth();

Type: int · Access: read-only

InitializeXNeeded​

No description yet.

bool GetProperty_InitializeXNeeded();
void SetProperty_InitializeXNeeded(bool argValue);

Type: bool · Access: read/write

IsMetafile​

No description yet.

bool GetProperty_IsMetafile();
void SetProperty_IsMetafile(bool argValue);

Type: bool · Access: read/write

IsPrinting​

No description yet.

bool GetProperty_IsPrinting();
void SetProperty_IsPrinting(bool argValue);

Type: bool · Access: read/write

IsXAxisInDefaultState​

No description yet.

bool GetProperty_IsXAxisInDefaultState();

Type: bool · Access: read-only

IsYComplex​

No description yet.

bool GetProperty_IsYComplex();

Type: bool · Access: read-only

LeftMargin​

No description yet.

int GetProperty_LeftMargin();
void SetProperty_LeftMargin(int argValue);

Type: int · Access: read/write

LogScaleBase​

No description yet.

int GetProperty_LogScaleBase();
void SetProperty_LogScaleBase(int argValue);

Type: int · Access: read/write

Maximum​

No description yet.

bool GetProperty_Maximum();
void SetProperty_Maximum(bool argValue);

Type: bool · Access: read/write

Minimum​

No description yet.

bool GetProperty_Minimum();
void SetProperty_Minimum(bool argValue);

Type: bool · Access: read/write

Name​

No description yet.

string GetProperty_Name();
void SetProperty_Name(string argValue);

Type: string · Access: read/write

Painter​

No description yet.

IPainter GetProperty_Painter();

Type: IPainter · Access: read-only

The accessors are extension methods of IChartHelper (using SCH;).

Parent​

No description yet.

IChartCollection GetProperty_Parent();

Type: IChartCollection · Access: read-only

The accessors are extension methods of IChartHelper (using SCH;).

Plot​

No description yet.

IPlot GetProperty_Plot(int argIndex);

Type: IPlot · Access: read-only · Index: argIndex (int)

The accessors are extension methods of IChartHelper (using SCH;).

PlotCount​

No description yet.

int GetProperty_PlotCount();

Type: int · Access: read-only

PlotIndexByPlot​

No description yet.

int GetProperty_PlotIndexByPlot(IPlot argPlot);

Type: int · Access: read-only · Index: argPlot (IPlot)

The accessors are extension methods of IChartHelper (using SCH;).

PlotsPerPrintedPage​

No description yet.

int GetProperty_PlotsPerPrintedPage();
void SetProperty_PlotsPerPrintedPage(int argValue);

Type: int · Access: read/write

PlottedWaveCount​

No description yet.

int GetProperty_PlottedWaveCount();

Type: int · Access: read-only

PrimaryYDataType​

No description yet.

TDataType GetProperty_PrimaryYDataType();
void SetProperty_PrimaryYDataType(TDataType argValue);

Type: TDataType · Access: read/write

The accessors are extension methods of IChartHelper (using SCH;).

RestoredFlag​

No description yet.

bool GetProperty_RestoredFlag();
void SetProperty_RestoredFlag(bool argValue);

Type: bool · Access: read/write

RightMargin​

No description yet.

int GetProperty_RightMargin();
void SetProperty_RightMargin(int argValue);

Type: int · Access: read/write

RMS​

No description yet.

bool GetProperty_RMS();
void SetProperty_RMS(bool argValue);

Type: bool · Access: read/write

SimRunning​

No description yet.

bool GetProperty_SimRunning();
void SetProperty_SimRunning(bool argValue);

Type: bool · Access: read/write

SourceWave​

No description yet.

ISourceWave GetProperty_SourceWave(int argIndex);

Type: ISourceWave · Access: read-only · Index: argIndex (int)

The accessors are extension methods of IChartHelper (using SCH;).

SourceWaveByName​

No description yet.

ISourceWave GetProperty_SourceWaveByName(string argName);

Type: ISourceWave · Access: read-only · Index: argName (string)

The accessors are extension methods of IChartHelper (using SCH;).

SourceWaveCount​

No description yet.

int GetProperty_SourceWaveCount();

Type: int · Access: read-only

SourceWaveIndexByName​

No description yet.

int GetProperty_SourceWaveIndexByName(string argName);

Type: int · Access: read-only · Index: argName (string)

Title​

No description yet.

string GetProperty_Title();
void SetProperty_Title(string argValue);

Type: string · Access: read/write

TopIndex​

No description yet.

int GetProperty_TopIndex();
void SetProperty_TopIndex(int argValue);

Type: int · Access: read/write

TopPlot​

No description yet.

IPlot GetProperty_TopPlot();

Type: IPlot · Access: read-only

The accessors are extension methods of IChartHelper (using SCH;).

UpdateFilteredStatus​

No description yet.

bool GetProperty_UpdateFilteredStatus();
void SetProperty_UpdateFilteredStatus(bool argValue);

Type: bool · Access: read/write

UseInitialXMinMax​

No description yet.

bool GetProperty_UseInitialXMinMax();
void SetProperty_UseInitialXMinMax(bool argValue);

Type: bool · Access: read/write

View​

No description yet.

TChartView GetProperty_View();

Type: TChartView · Access: read-only

The accessors are extension methods of IChartHelper (using SCH;).

VisiblePlots​

No description yet.

int GetProperty_VisiblePlots();
void SetProperty_VisiblePlots(int argValue);

Type: int · Access: read/write

WaveLabelFieldWidth​

No description yet.

int GetState_WaveLabelFieldWidth();

Type: int · Access: read-only

XAxisLabel​

No description yet.

string GetProperty_XAxisLabel();
void SetProperty_XAxisLabel(string argValue);

Type: string · Access: read/write

XDataType​

No description yet.

TDataType GetProperty_XDataType();
void SetProperty_XDataType(TDataType argValue);

Type: TDataType · Access: read/write

The accessors are extension methods of IChartHelper (using SCH;).

XDivisions​

No description yet.

int GetProperty_XDivisions();
void SetProperty_XDivisions(int argValue);

Type: int · Access: read/write

XDivSize​

No description yet.

double GetProperty_XDivSize();
void SetProperty_XDivSize(double argValue);

Type: double · Access: read/write

XMax​

No description yet.

double GetProperty_XMax();
void SetProperty_XMax(double argValue);

Type: double · Access: read/write

XMin​

No description yet.

double GetProperty_XMin();
void SetProperty_XMin(double argValue);

Type: double · Access: read/write

XOffset​

No description yet.

double GetProperty_XOffset();
void SetProperty_XOffset(double argValue);

Type: double · Access: read/write

XScaleFieldWidth​

No description yet.

int GetState_XScaleFieldWidth();

Type: int · Access: read-only

XScaleMode​

No description yet.

TScaleMode GetProperty_XScaleMode();
void SetProperty_XScaleMode(TScaleMode argValue);

Type: TScaleMode · Access: read/write

The accessors are extension methods of IChartHelper (using SCH;).

XUnits​

No description yet.

string GetProperty_XUnits();
void SetProperty_XUnits(string argValue);

Type: string · Access: read/write

XY​

No description yet.

bool GetProperty_XY();
void SetProperty_XY(bool argValue);

Type: bool · Access: read/write

YScaleFieldWidth​

No description yet.

int GetState_YScaleFieldWidth();

Type: int · Access: read-only

YScaleMode​

No description yet.

TScaleMode GetProperty_YScaleMode();
void SetProperty_YScaleMode(TScaleMode argValue);

Type: TScaleMode · Access: read/write

The accessors are extension methods of IChartHelper (using SCH;).

Methods​

MethodReturnsDescription
AddAWaveIPlottedWave
AddEquationWaveIPlottedWave
AddNewSourceWaveISourceWave
AddPlotint
AddSourceWaveint
AddWaveToTargetPlotvoid
AppendNewPlotIPlot
ChangeColorsvoid
ClearActivePrimitivevoid
ClearPlotvoid
ClearPlotsvoid
DefineNewWaveformbool
DeleteActivePlotvoid
DeleteActivePrimitivevoid
DeleteActiveWavevoid
DeleteSourceWavevoid
DeleteSourceWave_1void
DeleteWavevoid
DetermineDefaultXValuesvoid
DrawCursorsvoid
EditWavebool
FitWaveformsvoid
GetCellularTopMarginint
GetClipRectRect
GetCompatibleWavesListISourceWaveList
GetIdByWaveint
GetMaxAxisCountint
GetMaxXAxisPrecisionint
GetMaxYAxisPrecisionint
GetPlotByAxisIPlot
GetPlotByWaveIPlot
GetPlotIndexByAxisint
GetPlotIndexByWaveint
GetStandardTopMarginint
GetTableTopMarginint
GetWaveByIdIPlottedWave
GetXPositionint
HasNegativeXValuesbool
HideWavevoid
IndexOfCursorint
InitializeWaveColorsvoid
InsertNewPlotIPlot
InsertPlotvoid
MovePlotbool
MoveWavebool
NeedAxisRedrawbool
PlotHasCursorbool
RemovePlotvoid
ReplicateIChart
RescaleToXLimitsvoid
SetPrintValuesvoid
SetState_InitialGridXvoid
SetState_XMinMaxvoid
SetWaveFilteredStatusUpdateRequiredvoid
SetXScalevoid
ShowWaveIPlot
SizeAllPlotsvoid
SV_FormatXAxisvoid
SV_FormatYAxisvoid
SV_GetPlotByWaveNameIPlot
SV_NewDataPointvoid
SV_NewPoleZeroRootint
SV_NewWaveformint
SV_SetFourierFlagvoid
SV_ShowWaveOnPlotint
SV_UpdateChartvoid
Table_AddWavevoid
Table_ClearWavesvoid
Table_IndexOfWaveint
Table_MoveWavebool
Table_RemoveWavevoid
Table_WaveCountint
Table_WaveInterfacesIPlottedWave
Table_WavesIPlottedWave
UpdateAllPlotsvoid
UpdateAllPlots_1void
UpdateEquationWavevoid
UpdateFilteredStatusOfWavesvoid

AddAWave​

No description yet.

IPlottedWave AddAWave(ref bool argNewAxisFlag);
ParameterTypePassing
argNewAxisFlagboolref

Returns: IPlottedWave

Extension method of IChartHelper (using SCH;).

AddEquationWave​

No description yet.

IPlottedWave AddEquationWave(string argEquation, string argWaveName, TDataType argDataType, bool argForceNewPlotFlag, bool argNewAxisFlag);
ParameterTypePassing
argEquationstringvalue
argWaveNamestringvalue
argDataTypeTDataTypevalue
argForceNewPlotFlagboolvalue
argNewAxisFlagboolvalue

Returns: IPlottedWave

Extension method of IChartHelper (using SCH;).

AddNewSourceWave​

No description yet.

ISourceWave AddNewSourceWave(string argWaveName, bool argnXComplexFlag, bool argYComplexFlag, string argYUnitStr);
ParameterTypePassing
argWaveNamestringvalue
argnXComplexFlagboolvalue
argYComplexFlagboolvalue
argYUnitStrstringvalue

Returns: ISourceWave

Extension method of IChartHelper (using SCH;).

AddPlot​

No description yet.

int AddPlot(IPlot argPlot);
int AddPlot(object argPlot);
ParameterTypePassing
argPlotIPlotvalue

Returns: int

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

AddSourceWave​

No description yet.

int AddSourceWave(ISourceWave argWave);
int AddSourceWave(object argWave);
ParameterTypePassing
argWaveISourceWavevalue

Returns: int

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

AddWaveToTargetPlot​

No description yet.

void AddWaveToTargetPlot(IPlottedWave argMovedWave, IPlot argTargetPlot, bool argNewAxisFlag, bool argRescaleFlag);
void AddWaveToTargetPlot(object argMovedWave, object argTargetPlot, bool argNewAxisFlag, bool argRescaleFlag);
ParameterTypePassing
argMovedWaveIPlottedWavevalue
argTargetPlotIPlotvalue
argNewAxisFlagboolvalue
argRescaleFlagboolvalue

Returns: nothing (void)

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

AppendNewPlot​

No description yet.

IPlot AppendNewPlot(IPlottedWave argWave, int argPlotWidth);
ParameterTypePassing
argWaveIPlottedWavevalue
argPlotWidthintvalue

Returns: IPlot

Extension method of IChartHelper (using SCH;).

ChangeColors​

No description yet.

void ChangeColors();

Returns: nothing (void)

ClearActivePrimitive​

No description yet.

void ClearActivePrimitive();

Returns: nothing (void)

ClearPlot​

No description yet.

void ClearPlot(ref IPlot argPlot, bool argRemovePlot);
void ClearPlot(ref object argPlot, bool argRemovePlot);
ParameterTypePassing
argPlotIPlotref
argRemovePlotboolvalue

Returns: nothing (void)

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

ClearPlots​

No description yet.

void ClearPlots();

Returns: nothing (void)

DefineNewWaveform​

No description yet.

bool DefineNewWaveform(bool argNewPlotFlag);
ParameterTypePassing
argNewPlotFlagboolvalue

Returns: bool

DeleteActivePlot​

No description yet.

void DeleteActivePlot();

Returns: nothing (void)

DeleteActivePrimitive​

No description yet.

void DeleteActivePrimitive();

Returns: nothing (void)

DeleteActiveWave​

No description yet.

void DeleteActiveWave();

Returns: nothing (void)

DeleteSourceWave​

No description yet.

void DeleteSourceWave(int argIndex);
ParameterTypePassing
argIndexintvalue

Returns: nothing (void)

DeleteSourceWave_1​

No description yet.

void DeleteSourceWave_1(ISourceWave argWave);
void DeleteSourceWave_1(object argWave);
ParameterTypePassing
argWaveISourceWavevalue

Returns: nothing (void)

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

DeleteWave​

No description yet.

void DeleteWave(ref IPlottedWave argWave);
void DeleteWave(ref object argWave);
ParameterTypePassing
argWaveIPlottedWaveref

Returns: nothing (void)

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

DetermineDefaultXValues​

No description yet.

void DetermineDefaultXValues(ref double argnXMin, ref double argnXMax, ref double argnXOffset, ref double argnXDivSize, ref int argnXDivisionCount, TScaleMode argnXScaleMode, int argLogScaleBase);
void DetermineDefaultXValues(ref double argnXMin, ref double argnXMax, ref double argnXOffset, ref double argnXDivSize, ref int argnXDivisionCount, int argnXScaleMode, int argLogScaleBase);
ParameterTypePassing
argnXMindoubleref
argnXMaxdoubleref
argnXOffsetdoubleref
argnXDivSizedoubleref
argnXDivisionCountintref
argnXScaleModeTScaleModevalue
argLogScaleBaseintvalue

Returns: nothing (void)

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

DrawCursors​

No description yet.

void DrawCursors();

Returns: nothing (void)

EditWave​

No description yet.

bool EditWave(ref bool argNewAxisFlag, IPlottedWave argWave);
bool EditWave(ref bool argNewAxisFlag, object argWave);
ParameterTypePassing
argNewAxisFlagboolref
argWaveIPlottedWavevalue

Returns: bool

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

FitWaveforms​

No description yet.

void FitWaveforms();

Returns: nothing (void)

GetCellularTopMargin​

No description yet.

int GetCellularTopMargin();

Returns: int

GetClipRect​

No description yet.

Rect GetClipRect(int argLeft, int argTop, int argRight, int argBottom, IPainter argPainter);
ParameterTypePassing
argLeftintvalue
argTopintvalue
argRightintvalue
argBottomintvalue
argPainterIPaintervalue

Returns: Rect

Extension method of IChartHelper (using SCH;).

GetCompatibleWavesList​

No description yet.

ISourceWaveList GetCompatibleWavesList(IWaveList argWaveList);
ParameterTypePassing
argWaveListIWaveListvalue

Returns: ISourceWaveList

Extension method of IChartHelper (using SCH;).

GetIdByWave​

No description yet.

int GetIdByWave(IPlottedWave argWave);
int GetIdByWave(object argWave);
ParameterTypePassing
argWaveIPlottedWavevalue

Returns: int

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

GetMaxAxisCount​

No description yet.

int GetMaxAxisCount();

Returns: int

GetMaxXAxisPrecision​

No description yet.

int GetMaxXAxisPrecision();

Returns: int

GetMaxYAxisPrecision​

No description yet.

int GetMaxYAxisPrecision(IPlot argPlot);
int GetMaxYAxisPrecision(object argPlot);
ParameterTypePassing
argPlotIPlotvalue

Returns: int

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

GetPlotByAxis​

No description yet.

IPlot GetPlotByAxis(IPlotAxis argAxis);
ParameterTypePassing
argAxisIPlotAxisvalue

Returns: IPlot

Extension method of IChartHelper (using SCH;).

GetPlotByWave​

No description yet.

IPlot GetPlotByWave(IPlottedWave argWave);
ParameterTypePassing
argWaveIPlottedWavevalue

Returns: IPlot

Extension method of IChartHelper (using SCH;).

GetPlotIndexByAxis​

No description yet.

int GetPlotIndexByAxis(IPlotAxis argAxis);
int GetPlotIndexByAxis(object argAxis);
ParameterTypePassing
argAxisIPlotAxisvalue

Returns: int

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

GetPlotIndexByWave​

No description yet.

int GetPlotIndexByWave(IPlottedWave argWave);
int GetPlotIndexByWave(object argWave);
ParameterTypePassing
argWaveIPlottedWavevalue

Returns: int

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

GetStandardTopMargin​

No description yet.

int GetStandardTopMargin();

Returns: int

GetTableTopMargin​

No description yet.

int GetTableTopMargin();

Returns: int

GetWaveById​

No description yet.

IPlottedWave GetWaveById(int argnId);
ParameterTypePassing
argnIdintvalue

Returns: IPlottedWave

Extension method of IChartHelper (using SCH;).

GetXPosition​

No description yet.

int GetXPosition(double argxPlot, int argWidth, double argxRange);
ParameterTypePassing
argxPlotdoublevalue
argWidthintvalue
argxRangedoublevalue

Returns: int

HasNegativeXValues​

No description yet.

bool HasNegativeXValues();

Returns: bool

HideWave​

No description yet.

void HideWave(IPlottedWave argWave);
void HideWave(object argWave);
ParameterTypePassing
argWaveIPlottedWavevalue

Returns: nothing (void)

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

IndexOfCursor​

No description yet.

int IndexOfCursor(IMeasurementCursor argCursor);
int IndexOfCursor(object argCursor);
ParameterTypePassing
argCursorIMeasurementCursorvalue

Returns: int

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

InitializeWaveColors​

No description yet.

void InitializeWaveColors();

Returns: nothing (void)

InsertNewPlot​

No description yet.

IPlot InsertNewPlot(IPlot argReferencePlot);
ParameterTypePassing
argReferencePlotIPlotvalue

Returns: IPlot

Extension method of IChartHelper (using SCH;).

InsertPlot​

No description yet.

void InsertPlot(int argPlotIndex, IPlot argPlot);
void InsertPlot(int argPlotIndex, object argPlot);
ParameterTypePassing
argPlotIndexintvalue
argPlotIPlotvalue

Returns: nothing (void)

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

MovePlot​

No description yet.

bool MovePlot(int argFromIndex, int argToIndex);
ParameterTypePassing
argFromIndexintvalue
argToIndexintvalue

Returns: bool

MoveWave​

No description yet.

bool MoveWave(IPlottedWave argWave, IPlot argToPlot, IPlotAxis argToAxis, int argToIndex);
bool MoveWave(object argWave, object argToPlot, object argToAxis, int argToIndex);
ParameterTypePassing
argWaveIPlottedWavevalue
argToPlotIPlotvalue
argToAxisIPlotAxisvalue
argToIndexintvalue

Returns: bool

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

NeedAxisRedraw​

No description yet.

bool NeedAxisRedraw(bool argnIncreasingFlag);
ParameterTypePassing
argnIncreasingFlagboolvalue

Returns: bool

PlotHasCursor​

No description yet.

bool PlotHasCursor(IPlot argPlot);
bool PlotHasCursor(object argPlot);
ParameterTypePassing
argPlotIPlotvalue

Returns: bool

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

RemovePlot​

No description yet.

void RemovePlot(IPlot argPlot);
void RemovePlot(object argPlot);
ParameterTypePassing
argPlotIPlotvalue

Returns: nothing (void)

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

Replicate​

No description yet.

IChart Replicate();

Returns: IChart

Extension method of IChartHelper (using SCH;).

RescaleToXLimits​

No description yet.

void RescaleToXLimits();

Returns: nothing (void)

SetPrintValues​

No description yet.

void SetPrintValues(int argHeight, int argWidth, int argXOffset, int argYOffset);
ParameterTypePassing
argHeightintvalue
argWidthintvalue
argXOffsetintvalue
argYOffsetintvalue

Returns: nothing (void)

SetState_InitialGridX​

No description yet.

void SetState_InitialGridX();

Returns: nothing (void)

SetState_XMinMax​

No description yet.

void SetState_XMinMax();

Returns: nothing (void)

SetWaveFilteredStatusUpdateRequired​

No description yet.

void SetWaveFilteredStatusUpdateRequired();

Returns: nothing (void)

SetXScale​

No description yet.

void SetXScale(double argnXMin, double argnXMax, int argnXDivisions, TScaleMode argnXScaleMode, int argLogBase);
void SetXScale(double argnXMin, double argnXMax, int argnXDivisions, int argnXScaleMode, int argLogBase);
ParameterTypePassing
argnXMindoublevalue
argnXMaxdoublevalue
argnXDivisionsintvalue
argnXScaleModeTScaleModevalue
argLogBaseintvalue

Returns: nothing (void)

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

ShowWave​

No description yet.

IPlot ShowWave(IPlottedWave argWave, bool argForceNewPlotFlag, bool argNewAxisFlag, bool argKeepColorFlag);
ParameterTypePassing
argWaveIPlottedWavevalue
argForceNewPlotFlagboolvalue
argNewAxisFlagboolvalue
argKeepColorFlagboolvalue

Returns: IPlot

Extension method of IChartHelper (using SCH;).

SizeAllPlots​

No description yet.

void SizeAllPlots();

Returns: nothing (void)

SV_FormatXAxis​

No description yet.

void SV_FormatXAxis(string argXLabel, string argXUnitString, TSimViewGridType argGridType, double argMinX, double argMaxX);
void SV_FormatXAxis(string argXLabel, string argXUnitString, int argGridType, double argMinX, double argMaxX);
ParameterTypePassing
argXLabelstringvalue
argXUnitStringstringvalue
argGridTypeTSimViewGridTypevalue
argMinXdoublevalue
argMaxXdoublevalue

Returns: nothing (void)

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

SV_FormatYAxis​

No description yet.

void SV_FormatYAxis(string argFindPlotWaveName, string argYLabel);
ParameterTypePassing
argFindPlotWaveNamestringvalue
argYLabelstringvalue

Returns: nothing (void)

SV_GetPlotByWaveName​

No description yet.

IPlot SV_GetPlotByWaveName(string argWaveName);
ParameterTypePassing
argWaveNamestringvalue

Returns: IPlot

Extension method of IChartHelper (using SCH;).

SV_NewDataPoint​

No description yet.

void SV_NewDataPoint(int argWaveIndex, double argRealX, double argImagX, double argRealY, double argImagY);
ParameterTypePassing
argWaveIndexintvalue
argRealXdoublevalue
argImagXdoublevalue
argRealYdoublevalue
argImagYdoublevalue

Returns: nothing (void)

SV_NewPoleZeroRoot​

No description yet.

int SV_NewPoleZeroRoot(string argWaveName, string argFindPlotName, double argReal, double argImag, TSimViewPZType argPZType, string argUnitStr);
int SV_NewPoleZeroRoot(string argWaveName, string argFindPlotName, double argReal, double argImag, int argPZType, string argUnitStr);
ParameterTypePassing
argWaveNamestringvalue
argFindPlotNamestringvalue
argRealdoublevalue
argImagdoublevalue
argPZTypeTSimViewPZTypevalue
argUnitStrstringvalue

Returns: int

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

SV_NewWaveform​

No description yet.

int SV_NewWaveform(string argWaveName, string argFindPlotWaveName, bool argHiddenFlag, bool argnXComplexFlag, bool argYComplexFlag, string argYUnitStr);
ParameterTypePassing
argWaveNamestringvalue
argFindPlotWaveNamestringvalue
argHiddenFlagboolvalue
argnXComplexFlagboolvalue
argYComplexFlagboolvalue
argYUnitStrstringvalue

Returns: int

SV_SetFourierFlag​

No description yet.

void SV_SetFourierFlag(bool argFourierFlag);
ParameterTypePassing
argFourierFlagboolvalue

Returns: nothing (void)

SV_ShowWaveOnPlot​

No description yet.

int SV_ShowWaveOnPlot(string argWaveName, int argPlotIndex);
ParameterTypePassing
argWaveNamestringvalue
argPlotIndexintvalue

Returns: int

SV_UpdateChart​

No description yet.

void SV_UpdateChart();

Returns: nothing (void)

Table_AddWave​

No description yet.

void Table_AddWave(IPlottedWave argWave);
void Table_AddWave(object argWave);
ParameterTypePassing
argWaveIPlottedWavevalue

Returns: nothing (void)

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

Table_ClearWaves​

No description yet.

void Table_ClearWaves();

Returns: nothing (void)

Table_IndexOfWave​

No description yet.

int Table_IndexOfWave(IPlottedWave argWave);
int Table_IndexOfWave(object argWave);
ParameterTypePassing
argWaveIPlottedWavevalue

Returns: int

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

Table_MoveWave​

No description yet.

bool Table_MoveWave(int argFromIndex, int argToIndex);
ParameterTypePassing
argFromIndexintvalue
argToIndexintvalue

Returns: bool

Table_RemoveWave​

No description yet.

void Table_RemoveWave(int argIndex);
ParameterTypePassing
argIndexintvalue

Returns: nothing (void)

Table_WaveCount​

No description yet.

int Table_WaveCount();

Returns: int

Table_WaveInterfaces​

No description yet.

IPlottedWave Table_WaveInterfaces(int argIndex);
ParameterTypePassing
argIndexintvalue

Returns: IPlottedWave

Extension method of IChartHelper (using SCH;).

Table_Waves​

No description yet.

IPlottedWave Table_Waves(int argIndex);
ParameterTypePassing
argIndexintvalue

Returns: IPlottedWave

Extension method of IChartHelper (using SCH;).

UpdateAllPlots​

No description yet.

void UpdateAllPlots();

Returns: nothing (void)

UpdateAllPlots_1​

No description yet.

void UpdateAllPlots_1(int argPointIndex);
ParameterTypePassing
argPointIndexintvalue

Returns: nothing (void)

UpdateEquationWave​

No description yet.

void UpdateEquationWave(IPlottedWave argEquationWave, string argNewEquation, string argNewWaveName, TDataType argNewDataType);
void UpdateEquationWave(object argEquationWave, string argNewEquation, string argNewWaveName, int argNewDataType);
ParameterTypePassing
argEquationWaveIPlottedWavevalue
argNewEquationstringvalue
argNewWaveNamestringvalue
argNewDataTypeTDataTypevalue

Returns: nothing (void)

The first overload is an extension method of IChartHelper (using SCH;) with typed parameters; the second is declared by the interface.

UpdateFilteredStatusOfWaves​

No description yet.

void UpdateFilteredStatusOfWaves();

Returns: nothing (void)

Inherited members​

Returned by​

IAxis.ParentChartInterface, IChartCollection.ActiveChart, IChartCollection.Chart, IChartCollection.ChartByName, IChartCollection.ChartFFT_Create, IChartCollection.CreateNewChart, IChartCollection.NewChart, IChartCollection.SV_CreateChart, IChartCollection.SV_CreateFFT, IChartTitle.ParentChart, IPlot.ParentChart, IWave.ParentChart

Accepted by​

IChartCollection.AddChart, IChartCollection.AddDataPointToChart, IChartCollection.ChartFFT_Create, IChartCollection.ChartIndexByChart, IChartCollection.InsertChart, IChartCollection.SV_CreateFFT