Interface IChart

The system entity for a Chart, which is displays data from a IPivot and in turn a ISQLWrapper

See https://help.lemonedge.com/help/enterprise-data-tools/reporting/charts/intro.html for more information

Inherited Members
Namespace: LemonEdge.API.Entities.Reporting
Assembly: LemonEdge.API.dll
Syntax
[EntityDefinition(EntityID.Chart, "dbo.LT_Charts", "Chart", LabelColumn = "Name", IsStandingDataEntity = true, HelpURL = "help/enterprise-data-tools/reporting/charts/intro.html")]
[DefaultEntityIcon(ImageType.Charts)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.SQLWrapper, "OwnerEntityID", "ID", ExcludeFromRelationship = true)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.DataSourceIDs, "EntityID", "ID", ExcludeFromRelationship = true)]
[EntityIndex(Name = "Name", ColumnNames = new string[] { "UserID", "Name" }, IndexOrder = new IndexOrder[] { IndexOrder.Ascending, IndexOrder.Ascending }, IncludeColumns = new string[] { "SafeID", "Version", "FolderID", "Type", "AlgorithmStepID" }, IsClustered = false, IsUnique = false)]
public interface IChart : IBaseEntityWithPermissions, ISetCopier, IHasVersion, IUserSpecific, IHasFolderStructure, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

ColumnGrandTotalPosition

The position of any column grand totals

Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("The position to show any column grand totalling.")]
ChartTotalPosition ColumnGrandTotalPosition { get; set; }
Property Value
Type Description
ChartTotalPosition

ColumnSubTotalPosition

The position of any column sub totals

Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("The position to show any column sub totalling.")]
ChartTotalPosition ColumnSubTotalPosition { get; set; }
Property Value
Type Description
ChartTotalPosition

CombineMode

The mode in which data is combined

Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("The type of method to combine data in the chart.")]
ChartCombine CombineMode { get; set; }
Property Value
Type Description
ChartCombine

Description

A user friendly description of this chart

Declaration
[EntityProperty(SQLType.NVarChar, 2000, true)]
[EntityDescription("A user friendly description of this chart.")]
string Description { get; set; }
Property Value
Type Description
string

HelpURL

A unique html url for a help file specific for detailing the purpose of this chart and the data is analyses

Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
string HelpURL { get; set; }
Property Value
Type Description
string

HideLabels

Indicates if automatic labels should be hidden from view, and just tooltips provided

Declaration
[EntityProperty(SQLType.Bit, false)]
[EntityDescription("Indicates if all labels should be hidden on the chart.")]
bool HideLabels { get; set; }
Property Value
Type Description
bool

Name

[Key] The unique user friendly name of this chart

Declaration
[EntityProperty(SQLType.NVarChar, 500, false)]
[EntityKeyProperty]
[EntityDescription("The unique name of this chart.")]
[Unique]
[Required]
string Name { get; set; }
Property Value
Type Description
string

PivotID

Links to IPivot. The Pivot that is used to retrieve data for this Chart

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.Pivot, "ID", SingleJoinType.One, "Pivot", "Charts", DeleteWithRelationship = true, LinkToItemInSet = true, InheritPermissions = false)]
[RequiredNoDefaultIDValidation]
[EntityDescription("Holds the pivot data used as the data source for this chart.")]
Guid PivotID { get; set; }
Property Value
Type Description
Guid

RowGrandTotalPosition

The position of any row grand totals

Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("The position to show any row grand totalling.")]
ChartTotalPosition RowGrandTotalPosition { get; set; }
Property Value
Type Description
ChartTotalPosition

RowSubTotalPosition

The position of any row sub totals

Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("The position to show any row sub totalling.")]
ChartTotalPosition RowSubTotalPosition { get; set; }
Property Value
Type Description
ChartTotalPosition

SeriesFrom

The source of data for the series in the chart; Columns, Rows

Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("The series to use for this chart.")]
ChartSeriesFrom SeriesFrom { get; set; }
Property Value
Type Description
ChartSeriesFrom

Type

The type of chart

Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("The type of chart.")]
ChartType Type { get; set; }
Property Value
Type Description
ChartType

Extension Methods

See Also