PivotSettings Class

Relativity Services API
Represents the settings to use for a Pivot query.
Inheritance Hierarchy

System.Object
  Relativity.Services.Pivot.PivotSettings

Namespace:  Relativity.Services.Pivot
Assembly:  Relativity.Services.Interfaces (in Relativity.Services.Interfaces.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax

public class PivotSettings

The PivotSettings type exposes the following members.

Constructors

  NameDescription
Public methodPivotSettings
Initializes a new instance of the PivotSettings class.
Top
Properties

  NameDescription
Public propertyArtifactTypeID
Gets or sets the Relativity Artifact Type identifier (Artifact.ArtifactTypeID property) for the type of DTO to run a Pivot query against.
Public propertyConvertNumberFieldValuesToString
Gets or sets a Boolean value indicating whether to convert the numbers returned in the pivot to text.
Public propertyGroupBy
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.
Public propertyGroupByDateGrouping
Gets or sets the time interval to use when calculating results for a GroupBy field, if the GroupBy field is a Date field.
Public propertyMaximumNumberOfColumns
Gets or sets the maximum number of columns that a Pivot query can return.
Public propertyMaximumNumberOfRows
Gets or sets the maximum number of rows that a Pivot query can return.
Public propertyObjectSetQuery
Gets or sets a query that defines the base set of documents or objects to run a Pivot query against.
Public propertyPivotOn
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.
Public propertyPivotOnDateGrouping
Gets or sets the time interval to use when calculating results for a PivotOn field, if the PivotOn field is a Date field.
Public propertyRawDataOnly
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.
Public propertyTimeout
Gets or sets the maximum amount of time, in seconds, for running a Pivot query and calculating the results before timing out.
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also

Reference