IPlot interface

No description yet.

public interface IPlot : IPrimitive

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Inherits: IPrimitive

Properties

Property	Type	Access	Description
AllWavesHaveSameUnit	bool	get
AxisCount	int	get
AxisInterface	IPlotAxis	get
CellularHeight	int	get; set
CellularYMax	double	get; set
CellularYMin	double	get; set
FirstWave	IPlottedWave	get
GridArea	IGridArea	get
GridBottom	int	get; set
GridDivHeight	int	get; set
GridHeight	int	get
GridLeft	int	get
GridLines_MajorX	IGridLines	get
GridLines_MajorY	IGridLines	get
GridLines_MinorX	IGridLines	get
GridLines_MinorY	IGridLines	get
GridRight	int	get
GridStyle	ushort	get; set
GridTop	int	get; set
GridWidth	int	get
IsYUnitShowable	bool	get
MaxYUnitStrWidth	int	get
MeasurementCursorData	IMeasurementCursorData	get
MinorGrid	bool	get; set
ParentChart	IChart	get; set
PlotTitle	IPlotTitle	get
RelativeYPosition	int	get
ScaledForFullView	bool	get; set
SelectedAxisInterface	IPlotAxis	get; set
SelectionButton	ISelectionButton	get
Title	string	get; set
Visible	bool	get; set
WaveCount	int	get
WaveLabelFieldWidth	int	get
WaveLegend	IWaveLegend	get
XAxis	IXAxis	get
XGrid	bool	get; set
YGrid	bool	get; set

AllWavesHaveSameUnit

No description yet.

bool GetState_AllWavesHaveSameUnit();

Type: bool · Access: read-only

AxisCount

No description yet.

int GetProperty_AxisCount();

Type: int · Access: read-only

AxisInterface

No description yet.

IPlotAxis GetProperty_AxisInterface(int argIndex);

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

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

CellularHeight

No description yet.

int GetProperty_CellularHeight();
void SetProperty_CellularHeight(int argValue);

Type: int · Access: read/write

CellularYMax

No description yet.

double GetProperty_CellularYMax();
void SetProperty_CellularYMax(double argValue);

Type: double · Access: read/write

CellularYMin

No description yet.

double GetProperty_CellularYMin();
void SetProperty_CellularYMin(double argValue);

Type: double · Access: read/write

FirstWave

No description yet.

IPlottedWave GetProperty_FirstWave();

Type: IPlottedWave · Access: read-only

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

GridArea

No description yet.

IGridArea GetProperty_GridArea();

Type: IGridArea · Access: read-only

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

GridBottom

No description yet.

int GetProperty_GridBottom();
void SetProperty_GridBottom(int argValue);

Type: int · Access: read/write

GridDivHeight

No description yet.

int GetProperty_GridDivHeight();
void SetProperty_GridDivHeight(int argValue);

Type: int · Access: read/write

GridHeight

No description yet.

int GetProperty_GridHeight();

Type: int · Access: read-only

GridLeft

No description yet.

int GetProperty_GridLeft();

Type: int · Access: read-only

GridLines_MajorX

No description yet.

IGridLines GetProperty_GridLines_MajorX();

Type: IGridLines · Access: read-only

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

GridLines_MajorY

No description yet.

IGridLines GetProperty_GridLines_MajorY();

Type: IGridLines · Access: read-only

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

GridLines_MinorX

No description yet.

IGridLines GetProperty_GridLines_MinorX();

Type: IGridLines · Access: read-only

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

GridLines_MinorY

No description yet.

IGridLines GetProperty_GridLines_MinorY();

Type: IGridLines · Access: read-only

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

GridRight

No description yet.

int GetProperty_GridRight();

Type: int · Access: read-only

GridStyle

No description yet.

ushort GetProperty_GridStyle();
void SetProperty_GridStyle(ushort argValue);

Type: ushort · Access: read/write

GridTop

No description yet.

int GetProperty_GridTop();
void SetProperty_GridTop(int argValue);

Type: int · Access: read/write

GridWidth

No description yet.

int GetProperty_GridWidth();

Type: int · Access: read-only

IsYUnitShowable

No description yet.

bool GetState_IsYUnitShowable(IPlottedWave argnActiveWave);

Type: bool · Access: read-only · Index: argnActiveWave (IPlottedWave)

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

MaxYUnitStrWidth

No description yet.

int GetState_MaxYUnitStrWidth();

Type: int · Access: read-only

MeasurementCursorData

No description yet.

IMeasurementCursorData GetProperty_MeasurementCursorData();

Type: IMeasurementCursorData · Access: read-only

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

MinorGrid

No description yet.

bool GetProperty_MinorGrid();
void SetProperty_MinorGrid(bool argValue);

Type: bool · Access: read/write

ParentChart

No description yet.

IChart GetProperty_ParentChart();
void SetProperty_ParentChart(IChart argValue);

Type: IChart · Access: read/write

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

PlotTitle

No description yet.

IPlotTitle GetProperty_PlotTitle();

Type: IPlotTitle · Access: read-only

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

RelativeYPosition

No description yet.

int GetState_RelativeYPosition(double argyPlot);

Type: int · Access: read-only · Index: argyPlot (double)

ScaledForFullView

No description yet.

bool GetProperty_ScaledForFullView();
void SetProperty_ScaledForFullView(bool argValue);

Type: bool · Access: read/write

SelectedAxisInterface

No description yet.

IPlotAxis GetProperty_SelectedAxisInterface();
void SetProperty_SelectedAxisInterface(IPlotAxis argValue);

Type: IPlotAxis · Access: read/write

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

SelectionButton

No description yet.

ISelectionButton GetProperty_SelectionButton();

Type: ISelectionButton · Access: read-only

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

Title

No description yet.

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

Type: string · Access: read/write

Visible

No description yet.

bool GetProperty_Visible();
void SetProperty_Visible(bool argValue);

Type: bool · Access: read/write

WaveCount

No description yet.

int GetProperty_WaveCount();

Type: int · Access: read-only

WaveLabelFieldWidth

No description yet.

int GetState_WaveLabelFieldWidth();

Type: int · Access: read-only

WaveLegend

No description yet.

IWaveLegend GetProperty_WaveLegend();

Type: IWaveLegend · Access: read-only

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

XAxis

No description yet.

IXAxis GetProperty_XAxis();

Type: IXAxis · Access: read-only

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

XGrid

No description yet.

bool GetProperty_XGrid();
void SetProperty_XGrid(bool argValue);

Type: bool · Access: read/write

YGrid

No description yet.

bool GetProperty_YGrid();
void SetProperty_YGrid(bool argValue);

Type: bool · Access: read/write

Methods

Method	Returns	Description
AddAxis	void
AddEmptyAxis	void
AddWaveToNewAxis	void
BackupColors	void
DarkenColors	void
GetAxisForWave	IPlotAxis
GetFirstWave	IPlottedWave
GetFullWaveList	IPlottedWaveList
GetState_YMinMax	void
GetYPosition	int
IndexOfAxis	int
LightenColors	void
NewAxis	IPlotAxis
RemoveSelectedAxis	bool
RemoveWave	bool
Replicate	IPlot
RescaleToXLimits	void
RestoreColors	void
SelectAxis	void
SelectAxisByWave	void
SetState_InitialGridY	void
SizePlot	void
VerifyYScaling	void

AddAxis

No description yet.

void AddAxis(IPlotAxis argnAxis);
void AddAxis(object argnAxis);

Parameter	Type	Passing
argnAxis	IPlotAxis	value

Returns: nothing (void)

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

AddEmptyAxis

No description yet.

void AddEmptyAxis();

Returns: nothing (void)

AddWaveToNewAxis

No description yet.

void AddWaveToNewAxis(IPlottedWave argMovedWave);
void AddWaveToNewAxis(object argMovedWave);

Parameter	Type	Passing
argMovedWave	IPlottedWave	value

Returns: nothing (void)

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

BackupColors

No description yet.

void BackupColors();

Returns: nothing (void)

DarkenColors

No description yet.

void DarkenColors();

Returns: nothing (void)

GetAxisForWave

No description yet.

IPlotAxis GetAxisForWave(IPlottedWave argWave);

Parameter	Type	Passing
argWave	IPlottedWave	value

Returns: IPlotAxis

Extension method of IPlotHelper (using SCH;).

GetFirstWave

No description yet.

IPlottedWave GetFirstWave();

Returns: IPlottedWave

Extension method of IPlotHelper (using SCH;).

GetFullWaveList

No description yet.

IPlottedWaveList GetFullWaveList();

Returns: IPlottedWaveList

Extension method of IPlotHelper (using SCH;).

GetState_YMinMax

No description yet.

void GetState_YMinMax();

Returns: nothing (void)

GetYPosition

No description yet.

int GetYPosition(IPlotAxis argPlotAxis, double argyPlot, double argyRange);
int GetYPosition(object argPlotAxis, double argyPlot, double argyRange);

Parameter	Type	Passing
argPlotAxis	IPlotAxis	value
argyPlot	double	value
argyRange	double	value

Returns: int

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

IndexOfAxis

No description yet.

int IndexOfAxis(IPlotAxis argnAxis);
int IndexOfAxis(object argnAxis);

Parameter	Type	Passing
argnAxis	IPlotAxis	value

Returns: int

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

LightenColors

No description yet.

void LightenColors();

Returns: nothing (void)

NewAxis

No description yet.

IPlotAxis NewAxis();

Returns: IPlotAxis

Extension method of IPlotHelper (using SCH;).

RemoveSelectedAxis

No description yet.

bool RemoveSelectedAxis();

Returns: bool

RemoveWave

No description yet.

bool RemoveWave(IPlottedWave argWave);
bool RemoveWave(object argWave);

Parameter	Type	Passing
argWave	IPlottedWave	value

Returns: bool

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

Replicate

No description yet.

IPlot Replicate();

Returns: IPlot

Extension method of IPlotHelper (using SCH;).

RescaleToXLimits

No description yet.

void RescaleToXLimits(double argMin, double argMax);

Parameter	Type	Passing
argMin	double	value
argMax	double	value

Returns: nothing (void)

RestoreColors

No description yet.

void RestoreColors();

Returns: nothing (void)

SelectAxis

No description yet.

void SelectAxis(int argnAxisIndex);

Parameter	Type	Passing
argnAxisIndex	int	value

Returns: nothing (void)

SelectAxisByWave

No description yet.

void SelectAxisByWave(IPlottedWave argWave);
void SelectAxisByWave(object argWave);

Parameter	Type	Passing
argWave	IPlottedWave	value

Returns: nothing (void)

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

SetState_InitialGridY

No description yet.

void SetState_InitialGridY();

Returns: nothing (void)

SizePlot

No description yet.

void SizePlot();

Returns: nothing (void)

VerifyYScaling

No description yet.

void VerifyYScaling();

Returns: nothing (void)

Inherited members

• From IPrimitive: BoundingRect, ViewablePrimitiveId

Returned by

IAxis.ParentPlot, IChart.ActivePlot, IChart.AppendNewPlot, IChart.GetPlotByAxis, IChart.GetPlotByWave, IChart.InsertNewPlot, IChart.Plot, IChart.ShowWave, IChart.SV_GetPlotByWaveName, IChart.TopPlot, IGridArea.ParentPlot, IGridLines.ParentPlot, IMeasurementCursorData.ParentPlot, IPlotList.Plot, IPlotTitle.ParentPlot, ISelectionButton.ParentPlot, IWaveLegend.ParentPlot

Accepted by

IChart.AddPlot, IChart.AddWaveToTargetPlot, IChart.ClearPlot, IChart.CursorAWaveOnPlot, IChart.CursorBWaveOnPlot, IChart.GetMaxYAxisPrecision, IChart.InsertNewPlot, IChart.InsertPlot, IChart.MoveWave, IChart.PlotHasCursor, IChart.PlotIndexByPlot, IChart.RemovePlot, ISDFGraphicalView.ZoomToRect