ILanerCalculateSerie

Assembly: Laner;

Namespace: Prognoz.Platform.Interop.Laner;

Description

The ILanerCalculateSerie interface contains properties and methods used to work with a calculated series.

Inheritance Hierarchy

          INamedEntity

          ILanerSerie

          ILanerGroupSerie

          ILanerCalculateSerie

Comments

The ILanerCalculateSerie.Transform property that sets series calculation parameters must be set for a calculated series.

Properties

	Property name	Brief description
	CreateDerivedSeries	The CreateDerivedSeries property determines whether to add the calculated series (The Model Series, The Remainders and so on) as the child ones.
	DisplayDataAs	The DisplayDataAs property determines a mode of displaying values for calculated series.
	HasDiscrepancies	The HasDiscrepancies property returns whether the calculated data of the series differs from the data stored in database.
	Model	The Model property determines the model, into which the series was saved or from which it was restored.
	RevisionKey	The RevisionKey property returns the key of the revision, in which the calculated series was created.
	SaveLikeSource	Outdated. Use ILanerCalculateSerie.Save.
	ScenarioKey	The ScenarioKey property returns the key of the scenario, which data is contained in the series.
	Source	The Source property determines the calculated series source.
	SourceStub	The SourceStub property returns the data of the series as of an abstract data source.
	Transform	The Transform property returns the object, that enables the user to set up calculated series options.
	TransformPeriod	The TransformPeriod property returns the options of the calculated series calculation period.
	UserFormat	The UserFormat property determines name format for calculated series.
	UseTransform	The UseTransform property determines whether to use the series calculation options.

Properties Inherited from ILanerGroupSerie

	Property name	Brief description
	CanAddChildren	The CanAddChildren property returns whether child series can be added into the series group.
	Children	The Children property returns the series forming a group.
	Expanded	The Expanded property determines state of series group.

Properties Inherited from ILanerSerie

	Property name	Brief description
	CalendarDim	The CalendarDim property returns series calendar.
	Dependencies	The Dependencies property returns the series included into the given series.
	Dependents	The Dependents property returns series that contain the given series.
	DisplayParams	The DisplayParams property returns display parameters of series data.
	Hidden	The Hidden property determines whether a series is hidden in the workbook.
	Hint	The Hint property determines text of the tooltip displayed for a data series.
	IsChanged	The IsChanged property returns whether series data has any changes.
	Kind	The Kind property returns a type of series.
	Laner	The Laner property returns the time series database workbook that contains the given series.
	Level	The Level property returns calendar frequency of a series.
	MetaAttributeValueList	The MetaAttributeValueList property returns a collection of series attributes values.
	ObservationAttributeInValue	The ObservationAttributeInValue property determines a name of the observation attribute, values of which are displayed in the workbook table.
	ObservationValue	The ObservationValue property determines observation attribute value of a factor in defined calendar point.
	Parent	The Parent property returns a group that contains the series.
	ReadOnly	The ReadOnly property determines whether a series is read-only.
	ScenarioDimension	The ScenarioDimension property returns scenario dimension of series.
	SelectedUnit	The SelectedUnit property determines measuring units used to display series data.
	StrictlyDefined	The StrictlyDefined property returns whether all mandatory attributes of the series are defined.
	Stub	The Stub property returns source of series data.
	UserName	The UserName property determines whether the user defined a name for the time series.
	Visible	The Visible property determines whether a series is visible in the workbook.

Properties Inherited fromnbsp; INamedEntity

	Property name	Brief description
	Id	The Id property determines the object identifier.
	Key	The Key property returns the object key.
	Name	The Name property determines the object name.

Methods

	Method name	Brief description
	ApplyFormulaOnce	The ApplyFormulaOnce method performs a one time calculation of a calculated series according to the set options.
	Calculate	The Calculate method calculates the calculated series.
	CreateFactor	The CreateFactor method creates a factor based on a calculated series.
	CreateTemporaryTransform	The CreateTemporaryTransform method creates a temporary object, that enables to set up the calculated series calculation options.
	Error	The Error method displays the errors occurred during the series calculation.
	IndexOfDerivedType	The IndexOfDerivedType method returns the index of the child series of defined type.
	RefreshData	The RefreshData method updates the series data.
	ReleaseValues	The ReleaseValues method determines the series points display mode, in which the calculated values of the points are displayed in the workbook.
	Save	The Save method saves the series and returns the revision containing the changes made.
	SaveModel	The SaveModel method saves a calculated series as a model.
	SaveToFactor	Outdated. The SaveToFactor method saves the calculated series. The method is outdated, use Save.

Methods inherited from ILanerSerie

	Method name	Brief description
	MoveToParent	The MoveToParent method moves the series into the specified group of series.
	SearchFactor	The SearchFactor method searches in the time series database for a series that has the same values of the mandatory attributes as the current series.

See also:

Laner Assembly Interfaces