[EntityDefinition(EntityID.PivotFieldInfo, "dbo.LT_PivotFieldInfos", "PivotFieldInfo")]
[DefaultEntityIcon(ImageType.Charts)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.SQLWrapper, "OwnerEntityID", "ID", ExcludeFromRelationship = true)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.DataSourceIDs, "EntityID", "ID", ExcludeFromRelationship = true)]
public interface IPivotFieldInfo : IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

Aggregate

The aggregate operation to apply to the field if it is a value type.

Declaration

[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("Any aggregate function to be applied to this column.")]
AggregateFunction Aggregate { get; set; }

Property Value

Type	Description
AggregateFunction

DateFieldFormat

The format to apply to any date field

Declaration

[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("The format to group dates by.")]
PivotFieldDateFormat DateFieldFormat { get; set; }

Property Value

Type	Description
PivotFieldDateFormat

Format

Holds any formatting that should be applied to the displayed data in the pivot.

Declaration

[EntityProperty(SQLType.NVarChar, 50, true)]
[EntityDescription("Any formatting to be applied to the field.")]
string Format { get; set; }

Property Value

Type	Description
string

PivotID

[Key] Links to IPivot. The parent pivot this entity is a member of

Declaration

[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.Pivot, "ID", SingleJoinType.One, "Pivot", "Fields", DeleteWithRelationship = true, PartOfParentSet = true, InheritPermissions = true)]
[RequiredNoDefaultIDValidation]
[EntityKeyProperty]
Guid PivotID { get; set; }

Property Value

Type	Description
Guid

SQLTypeWrapperID

Links to ISQLTypeWrapper. The defintiion of a column from the sql wrapper schema for this pivot.

Declaration

[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.SQLTypeWrapper, "ID", SingleJoinType.One, "SQL Type Wrapper", "Pivot Fields", DeleteWithRelationship = true, PartOfParentSet = false, InheritPermissions = false)]
[RequiredNoDefaultIDValidation]
Guid SQLTypeWrapperID { get; set; }

Property Value

Type	Description
Guid

Sequence

The sequence this field info is loaded in to the pivot.

Declaration

[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("The sequence this field info is loaded in to the pivot.")]
[EntitySequence]
[EntityKeyProperty]
short Sequence { get; set; }

Property Value

Type	Description
short

SortAToZ

Indicates this field should be sorted in alphabetical order

Declaration

[EntityProperty(SQLType.Bit, false)]
[EntityDescription("Indicates if the field should be sorted in ascending order.")]
[Required]
bool SortAToZ { get; set; }

Property Value

Type	Description
bool

Type

The use this field should have in the pivot: Field, Filter, Column, Row, Value

Declaration

[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("The type of pivot field.")]
[Required]
[EntityKeyProperty]
PivotFieldType Type { get; set; }