IChartCollection interface

No description yet.

public interface IChartCollection

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
ActiveChart	IChart	get; set
ActiveChartIndex	int	get; set
ActiveChartName	string	get
Chart	IChart	get
ChartByName	IChart	get
ChartCount	int	get
ChartIndexByChart	int	get
ChartIndexByName	int	get
FileName	string	get
FilteredWavesBlend	int	get; set
FullyLoaded	bool	get; set
GraphicalView	ISDFGraphicalView	get
Modified	bool	get; set
ProcessForStopSimulator	string	get; set
RestoreSetup	bool	get; set
ServerWindow	ISDFDocument	get
SetupFileName	string	get
SetupFileWritten	bool	get
TotalPointCount	int	get
ViewManager	IViewManager	get

ActiveChart

No description yet.

IChart GetProperty_ActiveChart();
void SetProperty_ActiveChart(IChart argValue);

Type: IChart · Access: read/write

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

ActiveChartIndex

No description yet.

int GetProperty_ActiveChartIndex();
void SetProperty_ActiveChartIndex(int argValue);

Type: int · Access: read/write

ActiveChartName

No description yet.

string GetProperty_ActiveChartName();

Type: string · Access: read-only

Chart

No description yet.

IChart GetProperty_Chart(int argIndex);

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

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

ChartByName

No description yet.

IChart GetProperty_ChartByName(string argName);

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

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

ChartCount

No description yet.

int GetProperty_ChartCount();

Type: int · Access: read-only

ChartIndexByChart

No description yet.

int GetProperty_ChartIndexByChart(IChart argChart);

Type: int · Access: read-only · Index: argChart (IChart)

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

ChartIndexByName

No description yet.

int GetProperty_ChartIndexByName(string argName);

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

FileName

No description yet.

string GetProperty_FileName();

Type: string · Access: read-only

FilteredWavesBlend

No description yet.

int GetProperty_FilteredWavesBlend();
void SetProperty_FilteredWavesBlend(int argValue);

Type: int · Access: read/write

FullyLoaded

No description yet.

bool GetProperty_FullyLoaded();
void SetProperty_FullyLoaded(bool argValue);

Type: bool · Access: read/write

GraphicalView

No description yet.

ISDFGraphicalView GetProperty_GraphicalView();

Type: ISDFGraphicalView · Access: read-only

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

Modified

No description yet.

bool GetProperty_Modified();
void SetProperty_Modified(bool argValue);

Type: bool · Access: read/write

ProcessForStopSimulator

No description yet.

string GetProcessForStopSimulator();
void SetProcessForStopSimulator(string argProcess);

Type: string · Access: read/write

RestoreSetup

No description yet.

bool GetProperty_RestoreSetup();
void SetProperty_RestoreSetup(bool argValue);

Type: bool · Access: read/write

ServerWindow

No description yet.

ISDFDocument GetProperty_ServerWindow();

Type: ISDFDocument · Access: read-only

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

SetupFileName

No description yet.

string GetProperty_SetupFileName();

Type: string · Access: read-only

SetupFileWritten

No description yet.

bool GetProperty_SetupFileWritten();

Type: bool · Access: read-only

TotalPointCount

No description yet.

int GetProperty_TotalPointCount();

Type: int · Access: read-only

ViewManager

No description yet.

IViewManager GetProperty_ViewManager();

Type: IViewManager · Access: read-only

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

Methods

Method	Returns	Description
AddChart	int
AddDataPointToChart	void
ChartFFT_Create	IChart
ClearCharts	void
CreateNewChart	IChart
Delete_ChartSetups	void
DeleteChart	void
InsertChart	void
MoveChart	bool
NewChart	IChart
Save_ChartSetups	void
SetActiveChartByName	void
SV_ChartHeightInMils	int
SV_ChartHeightInPixels	int
SV_ChartWidthInMils	int
SV_ChartWidthInPixels	int
SV_CreateChart	IChart
SV_CreateFFT	IChart
SV_DataComplete	void
SV_FlushWindow	void
SV_ReDrawToDC	void
UpdateAllCharts	void

AddChart

No description yet.

int AddChart(IChart argChart);
int AddChart(object argChart);

Parameter	Type	Passing
argChart	IChart	value

Returns: int

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

AddDataPointToChart

No description yet.

void AddDataPointToChart(IChart argChart, ISourceWave argWave, double argRealX, double argnImaginaryX, double argRealY, double argnImaginaryY);
void AddDataPointToChart(object argChart, object argWave, double argRealX, double argnImaginaryX, double argRealY, double argnImaginaryY);

Parameter	Type	Passing
argChart	IChart	value
argWave	ISourceWave	value
argRealX	double	value
argnImaginaryX	double	value
argRealY	double	value
argnImaginaryY	double	value

Returns: nothing (void)

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

ChartFFT_Create

No description yet.

IChart ChartFFT_Create(IChart argChart);

Parameter	Type	Passing
argChart	IChart	value

Returns: IChart

Extension method of IChartCollectionHelper (using SCH;).

ClearCharts

No description yet.

void ClearCharts();

Returns: nothing (void)

CreateNewChart

No description yet.

IChart CreateNewChart(string argChartName, string argChartTitle, string argnXUnitStr, string argnXAxisLabel, bool argComplexFlag, TScaleMode argScaleMode, TSimViewChartType argChartType, TChartView argView, int argChartIndex);

Parameter	Type	Passing
argChartName	string	value
argChartTitle	string	value
argnXUnitStr	string	value
argnXAxisLabel	string	value
argComplexFlag	bool	value
argScaleMode	TScaleMode	value
argChartType	TSimViewChartType	value
argView	TChartView	value
argChartIndex	int	value

Returns: IChart

Extension method of IChartCollectionHelper (using SCH;).

Delete_ChartSetups

No description yet.

void Delete_ChartSetups(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: nothing (void)

DeleteChart

No description yet.

void DeleteChart(int argChartIndex);

Parameter	Type	Passing
argChartIndex	int	value

Returns: nothing (void)

InsertChart

No description yet.

void InsertChart(int argChartIndex, IChart argChart);
void InsertChart(int argChartIndex, object argChart);

Parameter	Type	Passing
argChartIndex	int	value
argChart	IChart	value

Returns: nothing (void)

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

MoveChart

No description yet.

bool MoveChart(int argCharts, int argToIndex);

Parameter	Type	Passing
argCharts	int	value
argToIndex	int	value

Returns: bool

NewChart

No description yet.

IChart NewChart(string argChartName);

Parameter	Type	Passing
argChartName	string	value

Returns: IChart

Extension method of IChartCollectionHelper (using SCH;).

Save_ChartSetups

No description yet.

void Save_ChartSetups();

Returns: nothing (void)

SetActiveChartByName

No description yet.

void SetActiveChartByName(string argName);

Parameter	Type	Passing
argName	string	value

Returns: nothing (void)

SV_ChartHeightInMils

No description yet.

int SV_ChartHeightInMils();

Returns: int

SV_ChartHeightInPixels

No description yet.

int SV_ChartHeightInPixels();

Returns: int

SV_ChartWidthInMils

No description yet.

int SV_ChartWidthInMils();

Returns: int

SV_ChartWidthInPixels

No description yet.

int SV_ChartWidthInPixels();

Returns: int

SV_CreateChart

No description yet.

IChart SV_CreateChart(string argChartName, TSimViewChartType argChartType, int argVisiblePlotCount, bool argRestoreSetupFlag);

Parameter	Type	Passing
argChartName	string	value
argChartType	TSimViewChartType	value
argVisiblePlotCount	int	value
argRestoreSetupFlag	bool	value

Returns: IChart

Extension method of IChartCollectionHelper (using SCH;).

SV_CreateFFT

No description yet.

IChart SV_CreateFFT(IChart argChart);

Parameter	Type	Passing
argChart	IChart	value

Returns: IChart

Extension method of IChartCollectionHelper (using SCH;).

SV_DataComplete

No description yet.

void SV_DataComplete(bool argInitialiseXY, string argTabNameString);

Parameter	Type	Passing
argInitialiseXY	bool	value
argTabNameString	string	value

Returns: nothing (void)

SV_FlushWindow

No description yet.

void SV_FlushWindow(bool argRestoreSetupFlag);

Parameter	Type	Passing
argRestoreSetupFlag	bool	value

Returns: nothing (void)

SV_ReDrawToDC

No description yet.

void SV_ReDrawToDC(uint argDC);

Parameter	Type	Passing
argDC	uint	value

Returns: nothing (void)

UpdateAllCharts

No description yet.

void UpdateAllCharts();

Returns: nothing (void)

Returned by

IChart.Parent, ISDFDocument.ChartCollection, ISDFGraphicalView.Charts, ISimViewDocument.ChartCollection