IPlotAxis interface

No description yet.

public interface IPlotAxis : IAxis

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Inherits: IPrimitive → IAxis

Properties

Property	Type	Access	Description
AutoUnits	bool	get; set
AutoYDiv	bool	get; set
AutoYMax	bool	get; set
AutoYMin	bool	get; set
AxisLabel	string	get; set
Units	string	get; set
WaveCount	int	get
WaveInterface	IPlottedWave	get
YDivisions	int	get; set
YDivSize	double	get; set
YOffset	double	get; set

AutoUnits

No description yet.

bool GetProperty_AutoUnits();
void SetProperty_AutoUnits(bool argValue);

Type: bool · Access: read/write

AutoYDiv

No description yet.

bool GetProperty_AutoYDiv();
void SetProperty_AutoYDiv(bool argValue);

Type: bool · Access: read/write

AutoYMax

No description yet.

bool GetProperty_AutoYMax();
void SetProperty_AutoYMax(bool argValue);

Type: bool · Access: read/write

AutoYMin

No description yet.

bool GetProperty_AutoYMin();
void SetProperty_AutoYMin(bool argValue);

Type: bool · Access: read/write

AxisLabel

No description yet.

string GetProperty_AxisLabel();
void SetProperty_AxisLabel(string argValue);

Type: string · Access: read/write

Units

No description yet.

string GetProperty_Units();
void SetProperty_Units(string argValue);

Type: string · Access: read/write

WaveCount

No description yet.

int GetProperty_WaveCount();

Type: int · Access: read-only

WaveInterface

No description yet.

IPlottedWave GetProperty_WaveInterface(int argIndex);

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

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

YDivisions

No description yet.

int GetProperty_YDivisions();
void SetProperty_YDivisions(int argValue);

Type: int · Access: read/write

YDivSize

No description yet.

double GetProperty_YDivSize();
void SetProperty_YDivSize(double argValue);

Type: double · Access: read/write

YOffset

No description yet.

double GetProperty_YOffset();
void SetProperty_YOffset(double argValue);

Type: double · Access: read/write

Methods

Method	Returns	Description
AddWave	int
AddWave_1	int
GetLabelString	string
GetScaleDetails	void
GetUnitsString	string
GetYLimits	void
IndexOfWave	int
InitAxis	void
InsertWave	void
InsertWave_1	void
ManualScaleChange	void
RemoveWave	void
RemoveWaveIfOwned	bool
Replicate	IPlotAxis
RescaleAxis	void
RescaleToXLimits	void
ScaleChange	void

AddWave

No description yet.

int AddWave(IPlottedWave argWave);
int AddWave(object argWave);

Parameter	Type	Passing
argWave	IPlottedWave	value

Returns: int

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

AddWave_1

No description yet.

int AddWave_1(IPlottedWave argWave, bool argRescaleFlag);
int AddWave_1(object argWave, bool argRescaleFlag);

Parameter	Type	Passing
argWave	IPlottedWave	value
argRescaleFlag	bool	value

Returns: int

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

GetLabelString

No description yet.

string GetLabelString(bool argShowWavesFlag, IPlottedWave argWave);
string GetLabelString(bool argShowWavesFlag, object argWave);

Parameter	Type	Passing
argShowWavesFlag	bool	value
argWave	IPlottedWave	value

Returns: string

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

GetScaleDetails

No description yet.

void GetScaleDetails(ref double argMin, ref double argMax);

Parameter	Type	Passing
argMin	double	ref
argMax	double	ref

Returns: nothing (void)

GetUnitsString

No description yet.

string GetUnitsString(IPlottedWave argWave);
string GetUnitsString(object argWave);

Parameter	Type	Passing
argWave	IPlottedWave	value

Returns: string

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

GetYLimits

No description yet.

void GetYLimits(ref double argMin, ref double argMax, ref int argDiv);

Parameter	Type	Passing
argMin	double	ref
argMax	double	ref
argDiv	int	ref

Returns: nothing (void)

IndexOfWave

No description yet.

int IndexOfWave(IPlottedWave argWave);
int IndexOfWave(object argWave);

Parameter	Type	Passing
argWave	IPlottedWave	value

Returns: int

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

InitAxis

No description yet.

void InitAxis();

Returns: nothing (void)

InsertWave

No description yet.

void InsertWave(int argWaveIndex, IPlottedWave argWave);
void InsertWave(int argWaveIndex, object argWave);

Parameter	Type	Passing
argWaveIndex	int	value
argWave	IPlottedWave	value

Returns: nothing (void)

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

InsertWave_1

No description yet.

void InsertWave_1(int argWaveIndex, IPlottedWave argWave, bool argRescaleFlag);
void InsertWave_1(int argWaveIndex, object argWave, bool argRescaleFlag);

Parameter	Type	Passing
argWaveIndex	int	value
argWave	IPlottedWave	value
argRescaleFlag	bool	value

Returns: nothing (void)

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

ManualScaleChange

No description yet.

void ManualScaleChange(double argMin, double argMax, double argDivSize, bool argnAutoMinFlag, bool argnAutoMaxFlag, bool argnAutoDivFlag);

Parameter	Type	Passing
argMin	double	value
argMax	double	value
argDivSize	double	value
argnAutoMinFlag	bool	value
argnAutoMaxFlag	bool	value
argnAutoDivFlag	bool	value

Returns: nothing (void)

RemoveWave

No description yet.

void RemoveWave(int argWaveIndex);

Parameter	Type	Passing
argWaveIndex	int	value

Returns: nothing (void)

RemoveWaveIfOwned

No description yet.

bool RemoveWaveIfOwned(IPlottedWave argWave);
bool RemoveWaveIfOwned(object argWave);

Parameter	Type	Passing
argWave	IPlottedWave	value

Returns: bool

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

Replicate

No description yet.

IPlotAxis Replicate();

Returns: IPlotAxis

Extension method of IPlotAxisHelper (using SCH;).

RescaleAxis

No description yet.

void RescaleAxis();

Returns: nothing (void)

RescaleToXLimits

No description yet.

void RescaleToXLimits(double argMin, double argMax);

Parameter	Type	Passing
argMin	double	value
argMax	double	value

Returns: nothing (void)

ScaleChange

No description yet.

void ScaleChange(double argMin, double argMax, int argDiv);

Parameter	Type	Passing
argMin	double	value
argMax	double	value
argDiv	int	value

Returns: nothing (void)

Inherited members

• From IAxis: ParentChartInterface, ParentPlot
• From IPrimitive: BoundingRect, ViewablePrimitiveId

Returned by

IPlot.AxisInterface, IPlot.GetAxisForWave, IPlot.NewAxis, IPlot.SelectedAxisInterface

Accepted by

IChart.GetPlotByAxis, IChart.GetPlotIndexByAxis, IChart.MoveWave, IPlot.AddAxis, IPlot.GetYPosition, IPlot.IndexOfAxis