Interface IPivotProcessor
A processor used for loading and processing IPivot and IPivotFieldInfo records as a set from the UI across multiple views in a consistent manner
See https://help.lemonedge.com/pivots/ for more information
Inherited Members
Namespace: LemonEdge.API.Core.Processors
Assembly: LemonEdge.API.dll
Syntax
public interface IPivotProcessor : IBaseDataSetProcessorWithDBSave, IBaseDataSetProcessor, IProcessor, IDisposableProperties
Fields
The fields used for the pivot
Declaration
IEnumerable<IPivotFieldInfo> Fields { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<IPivotFieldInfo> |
Pivot
The pivot handled by this processor
Declaration
IPivot Pivot { get; }Property Value
| Type | Description |
|---|---|
| IPivot |
SQLWrapper
An interprator for the ISQLWrapper used to power this pivot
Declaration
SQLWrapperInterpretor SQLWrapper { get; }Property Value
| Type | Description |
|---|---|
| SQLWrapperInterpretor |
Methods
CreateNewField(PivotFieldType, Guid)
Creates a new field for this pivot of the specified type. Also calls
OnAddField(IPivotFieldInfo) to register the new field.
Declaration
Task<IPivotFieldInfo> CreateNewField(PivotFieldType type, Guid sqlTypeWrapperID)Parameters
| Type | Name | Description |
|---|---|---|
| PivotFieldType | type | The type of field for the pivot to create |
| Guid | sqlTypeWrapperID | The sql wrapper column this field comes from so the processor knows the relationship for the pivot |
Returns
| Type | Description |
|---|---|
| Task<IPivotFieldInfo> | The new pivot field for this pivot |
LoadColumns()
Loads the SQLWrapper interprator for this processor
Automatically loaded from Load(), but can be called when changes are made to force loading
Declaration
Task LoadColumns()Returns
| Type | Description |
|---|---|
| Task | A task indicating the completion of this operation |
OnAddField(IPivotFieldInfo)
Adds a field item to this processor and registers it for tracking
Declaration
void OnAddField(IPivotFieldInfo item)Parameters
| Type | Name | Description |
|---|---|---|
| IPivotFieldInfo | item | The field item to add to this processor |
OnDeleteField(IPivotFieldInfo)
Removes a field item from this processor and stops tracking any changes with it
Declaration
void OnDeleteField(IPivotFieldInfo item)Parameters
| Type | Name | Description |
|---|---|---|
| IPivotFieldInfo | item | The field item to remove from this processor |