Relativity.Services.Pivot.PivotSettings

public class PivotSettings

Represents the settings to use for a Pivot query.

Documentation

public int ArtifactTypeID { get; set; }

Gets or sets the Relativity Artifact Type identifier (Artifact.ArtifactTypeID property) for the type of DTO to run a Pivot query against.

public bool? ConvertNumberFieldValuesToString { get; set; }

Gets or sets a Boolean value indicating whether to convert the numbers returned in the pivot to text.

public FieldRef GroupBy { get; set; }

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 PivotDateGrouping GroupByDateGrouping { get; set; }

Gets or sets the time interval to use when calculating results for a GroupBy field, if the GroupBy field is a Date field.

public int MaximumNumberOfColumns { get; set; }

Gets or sets the maximum number of columns that a Pivot query can return.

public int MaximumNumberOfRows { get; set; }

Gets or sets the maximum number of rows that a Pivot query can return.

public Query ObjectSetQuery { get; set; }

Gets or sets a query that defines the base set of documents or objects to run a Pivot query against.

public FieldRef PivotOn { get; set; }

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 PivotDateGrouping PivotOnDateGrouping { get; set; }

Gets or sets the time interval to use when calculating results for a PivotOn field, if the PivotOn field is a Date field.

public bool RawDataOnly { get; set; }

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 int Timeout { get; set; }

Gets or sets the maximum amount of time, in seconds, for running a Pivot query and calculating the results before timing out.

public PivotSettings()

Initializes a new instance of the PivotSettings class.