Configuration of a pivot dimension.
Inheritance
object
ComponentBase
Classes that extend this class.
Derived Classes- IComponent
- IHandleEvent
- IHandleAfterRender
- JsonSerializable
Constructors
Section titled "Constructors"constructor
public IgbPivotDimension()Returns IgbPivotDimension
Properties
Section titled "Properties"IgBlazor
Section titled "IgBlazor"Inherited from: BaseRendererElement
[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }IsComponentRooted
Section titled "IsComponentRooted"Inherited from: BaseRendererElement
public bool IsComponentRooted { get; }ParentTypeName
Section titled "ParentTypeName"Inherited from: BaseRendererElement
protected virtual string ParentTypeName { get; }UseDirectRender
Section titled "UseDirectRender"Inherited from: BaseRendererElement
protected virtual bool UseDirectRender { get; }ChildContent
Section titled "ChildContent"Inherited from: BaseRendererElement
[Parameter]
public RenderFragment ChildContent { get; set; }SupportsVisualChildren
Section titled "SupportsVisualChildren"Inherited from: BaseRendererElement
protected virtual bool SupportsVisualChildren { get; }Inherited from: BaseRendererElement
[Parameter]
public string Name { get; set; }Parent
Section titled "Parent"Inherited from: BaseRendererElement
public object Parent { get; }MethodTarget
Section titled "MethodTarget"Inherited from: BaseRendererElement
protected virtual string MethodTarget { get; }CurrParent
Section titled "CurrParent"Inherited from: BaseRendererElement
protected object CurrParent { get; }ChildLevel
Section titled "ChildLevel"Allows defining a hierarchy when multiple sub groups need to be extracted from single member.
[Parameter]
public IgbPivotDimension ChildLevel { get; set; }DataType
Section titled "DataType"The dataType of the related data field.
[Parameter]
public GridColumnDataType DataType { get; set; }DisplayName
Section titled "DisplayName"Display name to show instead of the field name of this value. *
[Parameter]
public string DisplayName { get; set; }Enabled
Section titled "Enabled"Enables/Disables a particular dimension from pivot structure.
[Parameter]
public bool Enabled { get; set; }Filter
Section titled "Filter"A predefined or defined via the igxPivotSelector filter expression tree for the current dimension to be applied in the filter pipe.
[Parameter]
public IgbFilteringExpressionsTree Filter { get; set; }HorizontalSummary
Section titled "HorizontalSummary"[Parameter]
public bool HorizontalSummary { get; set; }Level
Section titled "Level"Level of the dimension.
[Parameter]
public double Level { get; set; }MemberFunctionScript
Section titled "MemberFunctionScript"[Parameter]
public string MemberFunctionScript { get; set; }MemberName
Section titled "MemberName"Unique member to extract related data field value or the result of the memberFunction.
[Parameter]
public string MemberName { get; set; }SortDirection
Section titled "SortDirection"The sorting direction of the current dimension. Determines the order in which the values will appear in the related dimension.
[Parameter]
public SortingDirection SortDirection { get; set; }Sortable
Section titled "Sortable"Enable/disable sorting for a particular dimension. True by default.
[Parameter]
public bool Sortable { get; set; }public override string Type { get; }Width
Section titled "Width"The width of the dimension cells to be rendered.Can be pixel, % or "auto".
[Parameter]
public string Width { get; set; }Accessors
Section titled "Accessors"_name
Section titled "_name"Inherited from: BaseRendererElement
protected string _nameeventCallbacksCache
Section titled "eventCallbacksCache"Inherited from: BaseRendererElement
protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache_cachedSerializedContent
Section titled "_cachedSerializedContent"Inherited from: BaseRendererElement
protected string _cachedSerializedContentMethods
Section titled "Methods"EnsureModulesLoaded()
Section titled "EnsureModulesLoaded()"Inherited from: BaseRendererElement
protected virtual void EnsureModulesLoaded()Returns any
BuildRenderTree(RenderTreeBuilder)
Section titled "BuildRenderTree(RenderTreeBuilder)"Inherited from: BaseRendererElement
protected override void BuildRenderTree(RenderTreeBuilder builder)Parameters
- builder:
RenderTreeBuilder
Returns any
OnElementNameChanged(BaseRendererElement, string, string)
Section titled "OnElementNameChanged(BaseRendererElement, string, string)"Inherited from: BaseRendererElement
protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)Parameters
- element:
BaseRendererElement - oldName:
string - newName:
string
Returns any
InvokeMethod(string, object[], string[], ElementReference[])
Section titled "InvokeMethod(string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodSync(string, object[], string[], ElementReference[])
Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodHelper(string, string, object[], string[], ElementReference[])
Section titled "InvokeMethodHelper(string, string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected Task<object> InvokeMethodHelper(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements)Parameters
- target:
string - methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodHelperSync(string, string, object[], string[], ElementReference[])
Section titled "InvokeMethodHelperSync(string, string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected object InvokeMethodHelperSync(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements)Parameters
- target:
string - methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
IsPropDirty(string)
Section titled "IsPropDirty(string)"Inherited from: BaseRendererElement
protected bool IsPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
Serialize(SerializationContext, string)
Section titled "Serialize(SerializationContext, string)"Inherited from: BaseRendererElement
public void Serialize(SerializationContext context, string propertyName = null)Parameters
- context:
SerializationContext - propertyName:
string
Returns any
Serialize()
Section titled "Serialize()"Inherited from: BaseRendererElement
public string Serialize()Returns any
EnsureValid()
Section titled "EnsureValid()"Inherited from: BaseRendererElement
protected void EnsureValid()Returns any
SetResourceStringAsync(string, string, string)
Section titled "SetResourceStringAsync(string, string, string)"Inherited from: BaseRendererElement
protected Task<object> SetResourceStringAsync(string grouping, string id, string value)Parameters
- grouping:
string - id:
string - value:
string
Returns any
SetResourceStringAsync(string, string)
Section titled "SetResourceStringAsync(string, string)"Inherited from: BaseRendererElement
protected Task<object> SetResourceStringAsync(string grouping, string json)Parameters
- grouping:
string - json:
string
Returns any
FindByName(string)
Section titled "FindByName(string)"public override object FindByName(string name)Parameters
- name:
string
Returns any
FromEventJson(BaseRendererControl, Dictionary<string, object>)
Section titled "FromEventJson(BaseRendererControl, Dictionary<string, object>)"protected override void FromEventJson(BaseRendererControl control, Dictionary<string, object> args)Parameters
- control:
BaseRendererControl - args:
Dictionary
Returns any
SetNativeElement(object)
Section titled "SetNativeElement(object)"public void SetNativeElement(object element)Parameters
- element:
object
Returns any
SetNativeElementAsync(object)
Section titled "SetNativeElementAsync(object)"public Task SetNativeElementAsync(object element)Parameters
- element:
object
Returns any
ToEventJson(BaseRendererControl, Dictionary<string, object>)
Section titled "ToEventJson(BaseRendererControl, Dictionary<string, object>)"protected override void ToEventJson(BaseRendererControl control, Dictionary<string, object> args)Parameters
- control:
BaseRendererControl - args:
Dictionary