IPlottedWave interface
No description yet.
public interface IPlottedWave : IWave
Namespace: SCH · Assembly: Altium.SDK.Interfaces
Inherits: IPrimitive → IWave
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| Color | int | get; set | |
| EquationString | string | get; set | |
| Filtered | bool | get; set | |
| LastUpdateIndex | int | get; set | |
| LastUpdateTime | double | get; set | |
| MultiTrace | bool | get; set | |
| PrimaryLastPlottedX | int | get; set | |
| PrimaryLastPlottedY | int | get; set | |
| RunningYMax | double | get; set | |
| RunningYMin | double | get; set | |
| WaveLabel | IWaveLabel | get |
Color
No description yet.
int GetProperty_Color();
void SetProperty_Color(int argValue);
Type: int · Access: read/write
The accessors are extension methods of IPlottedWaveHelper (using SCH;).
EquationString
No description yet.
string GetProperty_EquationString();
void SetProperty_EquationString(string argValue);
Type: string · Access: read/write
Filtered
No description yet.
bool GetProperty_Filtered();
void SetProperty_Filtered(bool argValue);
Type: bool · Access: read/write
LastUpdateIndex
No description yet.
int GetProperty_LastUpdateIndex();
void SetProperty_LastUpdateIndex(int argValue);
Type: int · Access: read/write
LastUpdateTime
No description yet.
double GetProperty_LastUpdateTime();
void SetProperty_LastUpdateTime(double argValue);
Type: double · Access: read/write
MultiTrace
No description yet.
bool GetProperty_MultiTrace();
void SetProperty_MultiTrace(bool argValue);
Type: bool · Access: read/write
PrimaryLastPlottedX
No description yet.
int GetProperty_PrimaryLastPlottedX();
void SetProperty_PrimaryLastPlottedX(int argValue);
Type: int · Access: read/write
PrimaryLastPlottedY
No description yet.
int GetProperty_PrimaryLastPlottedY();
void SetProperty_PrimaryLastPlottedY(int argValue);
Type: int · Access: read/write
RunningYMax
No description yet.
double GetProperty_RunningYMax();
void SetProperty_RunningYMax(double argValue);
Type: double · Access: read/write
RunningYMin
No description yet.
double GetProperty_RunningYMin();
void SetProperty_RunningYMin(double argValue);
Type: double · Access: read/write
WaveLabel
No description yet.
IWaveLabel GetProperty_WaveLabel();
Type: IWaveLabel · Access: read-only
The accessors are extension methods of IPlottedWaveHelper (using SCH;).
Methods
| Method | Returns | Description |
|---|---|---|
| BackupColor | void | |
| CreateSourceList | void | |
| CreateWaveFromRef | void | |
| FormatWave | void | |
| GetNextPoint | int | |
| GetNextXVal | double | |
| Replicate | IPlottedWave | |
| RestoreColor | void | |
| SourceChange | void |
BackupColor
No description yet.
void BackupColor();
Returns: nothing (void)
CreateSourceList
No description yet.
void CreateSourceList(ISourceWaveList argSourceList);
void CreateSourceList(object argSourceList);
| Parameter | Type | Passing |
|---|---|---|
argSourceList | ISourceWaveList | value |
Returns: nothing (void)
The first overload is an extension method of IPlottedWaveHelper (using SCH;) with typed parameters; the second is declared by the interface.
CreateWaveFromRef
No description yet.
void CreateWaveFromRef();
Returns: nothing (void)
FormatWave
No description yet.
void FormatWave();
Returns: nothing (void)
GetNextPoint
No description yet.
int GetNextPoint(double argnXVal, int argDirection);
| Parameter | Type | Passing |
|---|---|---|
argnXVal | double | value |
argDirection | int | value |
Returns: int
GetNextXVal
No description yet.
double GetNextXVal(double argnXVal, int argDirection);
| Parameter | Type | Passing |
|---|---|---|
argnXVal | double | value |
argDirection | int | value |
Returns: double
Replicate
No description yet.
IPlottedWave Replicate();
Returns: IPlottedWave
Extension method of IPlottedWaveHelper (using SCH;).
RestoreColor
No description yet.
void RestoreColor();
Returns: nothing (void)
SourceChange
No description yet.
void SourceChange(string argOldName, string argNewName);
| Parameter | Type | Passing |
|---|---|---|
argOldName | string | value |
argNewName | string | value |
Returns: nothing (void)
Inherited members
- From IWave: AddPoint, ClearPoints, DataType, GetLineValues, GetMaximum, GetMinimum, GetNextPeak, GetNextTrough, GetRiseFallTime, GetState_MinMax, GetState_MinMax_1, GetTopLine, Hint, InsertPoint, Name, ParentChart, PointCount, SetDataIndeces, XComplex, XImag, XPlot, XReal, XValue, YComplex, YImag, YPlot, YReal, YUnits, YValue
- From IPrimitive: BoundingRect, ViewablePrimitiveId
Returned by
IChart.ActiveWave, IChart.AddAWave, IChart.AddEquationWave, IChart.GetWaveById, IChart.Table_WaveInterfaces, IChart.Table_Waves, IMeasurementCursor.WaveInterface, IPlot.FirstWave, IPlot.GetFirstWave, IPlotAxis.WaveInterface, IPlottedWaveList.PlottedWave, ISourceWave.MakeCopy, IWaveLabel.ParentWave
Accepted by
IChart.AddWaveToTargetPlot, IChart.AppendNewPlot, IChart.DeleteWave, IChart.EditWave, IChart.GetIdByWave, IChart.GetPlotByWave, IChart.GetPlotIndexByWave, IChart.HideWave, IChart.MoveWave, IChart.ShowWave, IChart.Table_AddWave, IChart.Table_IndexOfWave, IChart.UpdateEquationWave, IMeasurementCursor.Replicate, IPlot.AddWaveToNewAxis, IPlot.GetAxisForWave, IPlot.IsYUnitShowable, IPlot.RemoveWave, IPlot.SelectAxisByWave, IPlotAxis.AddWave, IPlotAxis.AddWave_1, IPlotAxis.GetLabelString, IPlotAxis.GetUnitsString, IPlotAxis.IndexOfWave, IPlotAxis.InsertWave, IPlotAxis.InsertWave_1, IPlotAxis.RemoveWaveIfOwned, ISDFGraphicalView.EnableCursor, IViewManager.SelectWave