Skip to content

IAdmReportChartTopRecords

The IAdmReportChartTopRecords interface represents a Top Records chart that displays the first N items sorted by a specific report column.

Inheritance: The IAdmReportChartTopRecords interface inherits from the IAdmReportChart interface.

Methods

Properties

  • Property

  • Description

  • NumberOfRecords

  • Gets or sets the number of top records in the report chart.

  • FirstColumn

  • Gets information about the first column in the report chart.

  • SortByColumn

  • Gets information about the column, based on which the report chart is built.

  • SortDescending

  • Gets or sets a value indicating whether records in the chart must be sorted in the descending order.

Details

GetRecords()

Returns top records for the report chart.

IAdmSearchResult[] GetRecords(IAdmListItems items, Object[] columnsToFetch)

Parameters

  • items - Specifies a list of report items.
  • columnsToFetch - Specifies an array of columns that must be present in the report chart (e.g. Name and Account Expires). Custom columns must be represented by the IAdmReportCustomColumn interface, not by the column ID.

Return value

An array of IAdmSearchResult interfaces that contain column values for chart records. The size of the array is specified by the NumberOfRecords property. Items in the array are sorted by the column specified in the SortByColumn property. To get a column value, pass the column name to the IAdmSearchResult::GetPropertyByName method as a property name. To get a value of a custom column, pass the custom column ID.


NumberOfRecords

Gets or sets the number of top records in the report chart.

  • Type:
  • Int32
  • Access:
  • Read/Write

FirstColumn

Gets information about the first column in the report chart.


SortByColumn

Gets information about the column, based on which the report chart is built. The column is also used to sort records in the chart.


SortDescending

Gets or sets a value indicating whether records in the chart must be sorted in the descending order.

  • Type:
  • Boolean
  • Access:
  • Read/Write

Requirements

Minimum required version: 2018.1

See also