Class Field

Allows you to configure the information retrieved from the data source for the field list.

Inheritance
object
Field
Inherited Members
Namespace: Syncfusion.Blazor.PivotView
Assembly: Syncfusion.Blazor.dll
Syntax
public class Field

Constructors

Field()

Declaration
public Field()

Properties

ActualFilter

It allows to set the list of currently applied filter values for this field.

Declaration
[JsonPropertyName("actualFilter")]
public List<string> ActualFilter { get; set; }
Property Value
Type
List<string>

AggregateType

It allows to set the current aggregate type to the specific field.

Declaration
[JsonPropertyName("aggregateType")]
public string AggregateType { get; set; }
Property Value
Type
string

AllMember

It allows to set the sentinel value that represents "All" members for this field.

Declaration
[JsonPropertyName("allMember")]
public string AllMember { get; set; }
Property Value
Type
string

AllowDragAndDrop

It allows to enable/disable the drag and drop option to grouping bar and field list button.

Declaration
[JsonPropertyName("allowDragAndDrop")]
public bool AllowDragAndDrop { get; set; }
Property Value
Type
bool

BaseField

It allows to set the selective field name to the field to perform aggregation.

Declaration
[JsonPropertyName("baseField")]
public string BaseField { get; set; }
Property Value
Type
string

BaseItem

It allows to set the selective member of the specific field to perform aggregation.

Declaration
[JsonPropertyName("baseItem")]
public string BaseItem { get; set; }
Property Value
Type
string

Caption

It allows to set the field caption.

Declaration
[JsonPropertyName("caption")]
public string Caption { get; set; }
Property Value
Type
string

ChildMembers

It allows to set child member definitions for hierarchical fields.

Declaration
[JsonPropertyName("childMembers")]
public List<Field> ChildMembers { get; set; }
Property Value
Type
List<Field>

CurrentMembers

It allows to set the current members map for this field.

Declaration
[JsonPropertyName("currentMembers")]
public Dictionary<string, Members> CurrentMembers { get; set; }
Property Value
Type
Dictionary<string, Members>

DateMember

It allows to set date members infomration of the specific field.

Declaration
[JsonPropertyName("dateMember")]
public List<DateMembers> DateMember { get; set; }
Property Value
Type
List<DateMembers>

DefaultHierarchy

It allows to set the default hierarchy name for this field.

Declaration
[JsonPropertyName("defaultHierarchy")]
public string DefaultHierarchy { get; set; }
Property Value
Type
string

ExpandAll

It allows you to expand or collapse all of the pivot table's headers for a specific field.

Declaration
[JsonPropertyName("expandAll")]
public bool ExpandAll { get; set; }
Property Value
Type
bool

Expanded

It allows to set a value indicating whether this field is expanded by default in the UI.

Declaration
[JsonPropertyName("expanded")]
public bool Expanded { get; set; }
Property Value
Type
bool

FieldType

It allows to set the runtime field type, such as "number", "string", or "datetime".

Declaration
[JsonPropertyName("fieldType")]
public string FieldType { get; set; }
Property Value
Type
string

Filter

It allows to set the current filter members to the specific field.

Declaration
[JsonPropertyName("filter")]
public List<string> Filter { get; set; }
Property Value
Type
List<string>

FilterMembers

It allows to set filter member definitions for this field.

Declaration
[JsonPropertyName("filterMembers")]
public List<Field> FilterMembers { get; set; }
Property Value
Type
List<Field>

FilterType

It allows to change the specific field's type.

Declaration
[JsonPropertyName("filterType")]
public string FilterType { get; set; }
Property Value
Type
string

Format

It allows to set the format to the specific field.

Declaration
[JsonPropertyName("format")]
public string Format { get; set; }
Property Value
Type
string

FormatString

It allows to set the current number format string of the field.

Declaration
[JsonPropertyName("formatString")]
public string FormatString { get; set; }
Property Value
Type
string

FormattedMembers

It allows to set members caption infomration of the specific field.

Declaration
[JsonPropertyName("formattedMembers")]
public Dictionary<string, Members> FormattedMembers { get; set; }
Property Value
Type
Dictionary<string, Members>

Formula

It allows to set the calculated field formula.

Declaration
[JsonPropertyName("formula")]
public string Formula { get; set; }
Property Value
Type
string

HasAllMember

It allows to set a value indicating whether the field includes an "All" member.

Declaration
[JsonPropertyName("hasAllMember")]
public bool HasAllMember { get; set; }
Property Value
Type
bool

HasChildren

It allows to set a value indicating whether this field has child members.

Declaration
[JsonPropertyName("hasChildren")]
public bool HasChildren { get; set; }
Property Value
Type
bool

HtmlAttributes

It allows to set additional HTML attributes for the field UI elements.

Declaration
[JsonPropertyName("htmlAttributes")]
public Dictionary<string, object> HtmlAttributes { get; set; }
Property Value
Type
Dictionary<string, object>

Id

It allows to set the field name.

Declaration
[JsonPropertyName("id")]
public string Id { get; set; }
Property Value
Type
string

Index

It allows to set the exact position of the specific field situated in the given data source.

Declaration
[JsonPropertyName("index")]
public int Index { get; set; }
Property Value
Type
int

IsCalculatedField

Allows to set whether is is a calculated field or not.

Declaration
[JsonPropertyName("isCalculatedField")]
public bool IsCalculatedField { get; set; }
Property Value
Type
bool

IsChecked

It allows to set a value indicating whether this field is currently checked/selected in the UI.

Declaration
[JsonPropertyName("isChecked")]
public bool IsChecked { get; set; }
Property Value
Type
bool

IsCustomField

Allows to set wheather the specific field is custom grouped or not.

Declaration
[JsonPropertyName("isCustomField")]
public bool IsCustomField { get; set; }
Property Value
Type
bool

IsExcelFilter

Allows to set the specific field for excel-like filtering.

Declaration
[JsonPropertyName("isExcelFilter")]
public bool IsExcelFilter { get; set; }
Property Value
Type
bool

IsHierarchy

It allows to set a value indicating whether this field is a hierarchical field.

Declaration
[JsonPropertyName("isHierarchy")]
public bool IsHierarchy { get; set; }
Property Value
Type
bool

IsNamedSets

It allows to set a value indicating whether this field represents named sets (OLAP).

Declaration
[JsonPropertyName("isNamedSets")]
public bool IsNamedSets { get; set; }
Property Value
Type
bool

IsSelected

Allows to set whether the specific field is selected or not.

Declaration
[JsonPropertyName("isSelected")]
public bool IsSelected { get; set; }
Property Value
Type
bool

LevelCount

It allows to set the number of levels available for this field (hierarchical fields).

Declaration
[JsonPropertyName("levelCount")]
public int LevelCount { get; set; }
Property Value
Type
int

Levels

It allows to set the levels (hierarchies) for this field.

Declaration
[JsonPropertyName("levels")]
public List<Field> Levels { get; set; }
Property Value
Type
List<Field>

MemberType

It allows to set the member type for this field.

Declaration
[JsonPropertyName("memberType")]
public int MemberType { get; set; }
Property Value
Type
int

Members

It allows to set members information of the specific field.

Declaration
[JsonPropertyName("members")]
public Dictionary<string, Members> Members { get; set; }
Property Value
Type
Dictionary<string, Members>

Name

It allows to set the field name.

Declaration
[JsonPropertyName("name")]
public string Name { get; set; }
Property Value
Type
string

ParentHierarchy

It allows to set the parent hierarchy name for this field (OLAP only).

Declaration
[JsonPropertyName("parentHierarchy")]
public string ParentHierarchy { get; set; }
Property Value
Type
string

Pid

It allows to set the parent name.

Declaration
[JsonPropertyName("pid")]
public string Pid { get; set; }
Property Value
Type
string

SearchMembers

It allows to set the searchable members for this field.

Declaration
[JsonPropertyName("searchMembers")]
public List<Field> SearchMembers { get; set; }
Property Value
Type
List<Field>

ShowEditIcon

It allows to set the visibility of calculated field edit icon in grouping bar and field list button.

Declaration
[JsonPropertyName("showEditIcon")]
public bool ShowEditIcon { get; set; }
Property Value
Type
bool

ShowFilterIcon

It allows to set the visibility of filter icon in grouping bar and field list button.

Declaration
[JsonPropertyName("showFilterIcon")]
public bool ShowFilterIcon { get; set; }
Property Value
Type
bool

ShowNoDataItems

Allows to set the specific field to display the data items that are not in combination with respect to current report.

Declaration
[JsonPropertyName("showNoDataItems")]
public bool ShowNoDataItems { get; set; }
Property Value
Type
bool

ShowRemoveIcon

It allows to set the visibility of remove icon in grouping bar button.

Declaration
[JsonPropertyName("showRemoveIcon")]
public bool ShowRemoveIcon { get; set; }
Property Value
Type
bool

ShowSortIcon

It allows to set the visibility of sort icon in grouping bar and field list button.

Declaration
[JsonPropertyName("showSortIcon")]
public bool ShowSortIcon { get; set; }
Property Value
Type
bool

ShowSubTotals

It allows enable/disable sub total in pivot table.

Declaration
[JsonPropertyName("showSubTotals")]
public bool ShowSubTotals { get; set; }
Property Value
Type
bool

ShowValueTypeIcon

It allows to set the visibility of summay type drop down icon in grouping bar and field list button.

Declaration
[JsonPropertyName("showValueTypeIcon")]
public bool ShowValueTypeIcon { get; set; }
Property Value
Type
bool

Sort

It allows to set the current sort order to the specific field.

Declaration
[JsonPropertyName("sort")]
public string Sort { get; set; }
Property Value
Type
string

SpriteCssClass

It allows to set the CSS class for the sprite/icon for this field.

Declaration
[JsonPropertyName("spriteCssClass")]
public string SpriteCssClass { get; set; }
Property Value
Type
string

Tag

It allows to set an arbitrary tag value associated with this field.

Declaration
[JsonPropertyName("tag")]
public string Tag { get; set; }
Property Value
Type
string

Type

It allows to set the field type to be either number or string or data or datetime.

Declaration
[JsonPropertyName("type")]
public string Type { get; set; }
Property Value
Type
string