Represents the settings to use for a Pivot query.
Inheritance Hierarchy
Relativity.Services.Pivot.PivotSettings
Namespace: Relativity.Services.Pivot
Assembly: Relativity.Services.Interfaces (in Relativity.Services.Interfaces.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
The PivotSettings type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | PivotSettings |
Initializes a new instance of the PivotSettings class.
|
Properties
Name | Description | |
---|---|---|
![]() | ArtifactTypeID |
Gets or sets the Relativity Artifact Type identifier (Artifact.ArtifactTypeID property) for the type of DTO to run a Pivot query against.
|
![]() | ConvertNumberFieldValuesToString |
Gets or sets a Boolean value indicating whether to convert the numbers returned in the pivot to text.
|
![]() | GroupBy |
Gets or sets the field to use as the Group By value in a Pivot query and result set. Grouping functionality (Field.AllowGroupBy property) must be enabled for a field before the field can be used as a GroupBy field.
|
![]() | GroupByDateGrouping |
Gets or sets the time interval to use when calculating results for a GroupBy field, if the GroupBy field is a Date field.
|
![]() | MaximumNumberOfColumns |
Gets or sets the maximum number of columns that a Pivot query can return.
|
![]() | MaximumNumberOfRows |
Gets or sets the maximum number of rows that a Pivot query can return.
|
![]() | ObjectSetQuery |
Gets or sets a query that defines the base set of documents or objects to run a Pivot query against.
|
![]() | PivotOn |
Gets or sets the field to use as the Pivot On value in a Pivot query and result set. Pivot functionality (Field.AllowPivotOn property) must be enabled for a field before the field can be used as a PivotOn field.
|
![]() | PivotOnDateGrouping |
Gets or sets the time interval to use when calculating results for a PivotOn field, if the PivotOn field is a Date field.
|
![]() | RawDataOnly |
Gets or sets a value that indicates whether to apply a Pivot view to the data returned by a Pivot query or to return only the data. If the value is true, only the data is returned.
|
![]() | Timeout |
Gets or sets the maximum amount of time, in seconds, for running a Pivot query and calculating the results before timing out.
|
Methods
Name | Description | |
---|---|---|
![]() | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also