Class Chart
Assembly: LemonEdge.API.Entities.Auto.dll
Syntax
[DataContract]
public class Chart : BaseEntityWithPermissions, IChart, IBaseEntityWithPermissions, ISetCopier, IHasVersion, IUserSpecific, IHasFolderStructure, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ICloneableAsync<IChart>, IUserSpecificPublicToggle
Constructors
Chart()
Declaration
Properties
ColumnGrandTotalPosition
The position of any column grand totals
Declaration
[EnumDataType(typeof(ChartTotalPosition))]
public ChartTotalPosition ColumnGrandTotalPosition { get; set; }
Property Value
Declaration
[NotMapped]
public string ColumnGrandTotalPosition_Tooltip { get; set; }
Property Value
ColumnSubTotalPosition
The position of any column sub totals
Declaration
[EnumDataType(typeof(ChartTotalPosition))]
public ChartTotalPosition ColumnSubTotalPosition { get; set; }
Property Value
Declaration
[NotMapped]
public string ColumnSubTotalPosition_Tooltip { get; set; }
Property Value
CombineMode
The mode in which data is combined
Declaration
[EnumDataType(typeof(ChartCombine))]
public ChartCombine CombineMode { get; set; }
Property Value
Declaration
[NotMapped]
public string CombineMode_Tooltip { get; set; }
Property Value
Description
A user friendly description of this chart
Declaration
[StringLength(2000)]
public string Description { get; set; }
Property Value
FolderID
The link to the folder this item is contained in
Declaration
public Guid? FolderID { get; set; }
Property Value
FolderID_Label
Declaration
public string FolderID_Label { get; set; }
Property Value
FolderID_Label_Silent
Declaration
[NotMapped]
public string FolderID_Label_Silent { get; set; }
Property Value
HelpURL
A unique html url for a help file specific for detailing the purpose of this chart and the data is analyses
Declaration
[StringLength(500)]
public string HelpURL { get; set; }
Property Value
HideLabels
Indicates if automatic labels should be hidden from view, and just tooltips provided
Declaration
public bool HideLabels { get; set; }
Property Value
IsPublic
Indicates if this entity is visible to all users (public), or just the current user (private).
Directly maps to UserID property
Declaration
[NotMapped]
public bool IsPublic { get; set; }
Property Value
IsSystem
Indicates this item is part of the core system. Any changes will be overwritten if the version number is lower than
the provided version number and the item is also marked as a system item.
Declaration
[Required]
public bool IsSystem { get; set; }
Property Value
Name
[Key] The unique user friendly name of this chart
Declaration
[Unique]
[Required]
[StringLength(500)]
public string Name { get; set; }
Property Value
PivotID
Links to IPivot. The Pivot that is used to retrieve data for this Chart
Declaration
[RequiredNoDefaultIDValidation]
public Guid PivotID { get; set; }
Property Value
PivotID_Label
Declaration
public string PivotID_Label { get; set; }
Property Value
PivotID_Label_Silent
Declaration
[NotMapped]
public string PivotID_Label_Silent { get; set; }
Property Value
RowGrandTotalPosition
The position of any row grand totals
Declaration
[EnumDataType(typeof(ChartTotalPosition))]
public ChartTotalPosition RowGrandTotalPosition { get; set; }
Property Value
Declaration
[NotMapped]
public string RowGrandTotalPosition_Tooltip { get; set; }
Property Value
RowSubTotalPosition
The position of any row sub totals
Declaration
[EnumDataType(typeof(ChartTotalPosition))]
public ChartTotalPosition RowSubTotalPosition { get; set; }
Property Value
Declaration
[NotMapped]
public string RowSubTotalPosition_Tooltip { get; set; }
Property Value
SeriesFrom
The source of data for the series in the chart; Columns, Rows
Declaration
[EnumDataType(typeof(ChartSeriesFrom))]
public ChartSeriesFrom SeriesFrom { get; set; }
Property Value
Declaration
[NotMapped]
public string SeriesFrom_Tooltip { get; set; }
Property Value
Type
Declaration
[EnumDataType(typeof(ChartType))]
public ChartType Type { get; set; }
Property Value
Declaration
[NotMapped]
public string Type_Tooltip { get; set; }
Property Value
UserID
Links to IUser. Indicates if this entity record is private to just the specified user, or if it is
public to everyone (holding null)
Declaration
public Guid? UserID { get; set; }
Property Value
UserID_Label
Declaration
public string UserID_Label { get; set; }
Property Value
UserID_Label_Silent
Declaration
[NotMapped]
public string UserID_Label_Silent { get; set; }
Property Value
Version
Indicates the version number of this item. Changes will only be overwritten if the provided new item has a higer
version number than this one.
Declaration
[Required]
[DatabasePropertyValidation("MyItem.IsSystem", "var allUserTeams = await Cache.GetAllItems<LemonEdge.API.Entities.Administration.IUserTeam>(); (await Cache.GetAllItems<LemonEdge.API.Entities.Administration.ITeam>()).Any(x => allUserTeams.Where(ut => ut.UserID == User.ID).Select(ut => ut.TeamID).Contains(x.ID) && x.CanEditSystemItems)", "User is not authorized to modify system items.")]
public short Version { get; set; }
Property Value
Methods
CopyFromEntity(IBaseEntity)
Declaration
protected override void CopyFromEntity(IBaseEntity src)
Parameters
Overrides
CopyFromSource(IChart)
Updates all properties in this item to have the same properties as the source object.
Declaration
public void CopyFromSource(IChart source)
Parameters
Type |
Name |
Description |
IChart |
source |
The source object to copy all values from.
|
ToString()
Declaration
public override string ToString()
Returns
Overrides
Implements
Extension Methods