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://web.lemonedge.com/help/pivots/ for more information
Inherited Members
System.IEquatable<LemonEdge.API.Core.IBaseEntity>.Equals(LemonEdge.API.Core.IBaseEntity)
System.ComponentModel.INotifyPropertyChanged.PropertyChanged
System.ComponentModel.INotifyPropertyChanging.PropertyChanging
Namespace: LemonEdge.API.Entities
Assembly: API.dll
Syntax
[EntityDefinition(EntityID.Pivot, "dbo.LT_Pivots", "Pivot", LabelColumn = "Name", IsStandingDataEntity = true, HelpURL = "pivots")]
[DefaultEntityIcon(ImageType.Pivot)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.SQLWrapper, "OwnerEntityID", "ID", ExcludeFromRelationship = true)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.Transaction, "ParentItemID", "ID", ExcludeFromRelationship = true)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.DataSourceIDs, "EntityID", "ID", ExcludeFromRelationship = true)]
public interface IPivot : IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ISetCopier, IHasVersion, IUserSpecific
Properties
Description
A user friendly description of this pivot
Declaration
[EntityProperty(SQLType.NVarChar, (short)2000, true)]
[EntityDescription("A user friendly description of this pivot.")]
string Description { get; set; }
Property Value
Type | Description |
---|---|
System.String |
HelpURL
A custom url for help on this pivot
Declaration
[EntityProperty(SQLType.NVarChar, (short)500, true)]
string HelpURL { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Name
[Key] The unique user friendly name for this pivot
Declaration
[EntityProperty(SQLType.NVarChar, (short)500, false)]
[EntityDescription("The unique name of this data pivot.")]
[Required]
string Name { get; set; }
Property Value
Type | Description |
---|---|
System.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, "SQLWrapper", "Pivot", DeleteWithRelationship = true, LinkToItemInSet = true, InheritPermissions = false)]
[EntityDescription("Holds the sql wrapper this pivot uses as the data source.")]
Guid SQLWrapperID { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |