Interface IPivot
The system entity for a pivot entity, which is capable of taking any sql wrapper of data and pivotting it dynamically
See https://help.lemonedge.com/help/enterprise-data-tools/reporting/pivots/intro.html for more information
Inherited Members
Namespace: LemonEdge.API.Entities.Reporting
Assembly: LemonEdge.API.dll
Syntax
[EntityDefinition(EntityID.Pivot, "dbo.LT_Pivots", "Pivot", LabelColumn = "Name", IsStandingDataEntity = true, HelpURL = "help/enterprise-data-tools/reporting/pivots/intro.html")]
[DefaultEntityIcon(ImageType.Pivot)]
[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", "AlgorithmStepID" }, IsClustered = false, IsUnique = false)]
public interface IPivot : IBaseEntityWithPermissions, ISetCopier, IHasVersion, IUserSpecific, IHasFolderStructure, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties
Properties
Description
A user friendly description of this pivot
Declaration
[EntityProperty(SQLType.NVarChar, 2000, true)]
[EntityDescription("A user friendly description of this pivot.")]
string Description { get; set; }
Property Value
Type | Description |
---|---|
string |
HelpURL
A custom url for help on this pivot
Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
string HelpURL { get; set; }
Property Value
Type | Description |
---|---|
string |
Name
[Key] The unique user friendly name for this pivot
Declaration
[EntityProperty(SQLType.NVarChar, 500, false)]
[EntityKeyProperty]
[EntityDescription("The unique name of this data pivot.")]
[Unique]
[Required]
string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
PivotAxis
The axis to pivot data around.
Declaration
[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("The axis to pivot data around.")]
PivotAxis PivotAxis { get; set; }
Property Value
Type | Description |
---|---|
PivotAxis |
SQLWrapperID
Links to ISQLWrapper. The SQL Wrapper that is used to retrieve data to analyse in this pivot.
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.SQLWrapper, "ID", SingleJoinType.One, "SQL Wrapper", "Pivots", DeleteWithRelationship = true, LinkToItemInSet = true, InheritPermissions = false)]
[RequiredNoDefaultIDValidation]
[EntityDescription("Holds the sql wrapper this pivot uses as the data source.")]
Guid SQLWrapperID { get; set; }
Property Value
Type | Description |
---|---|
Guid |