setOptions - Methods - Reports API

Reports API Methods

setOptions()

Configures the report's interface and behavior after initialization.

You would want to use this to adjust the columns and group ancestors after the report has already loaded.

Important Only applicable to the sessions summary by group and activity summary by group reports.

Examples

// Hide the group ancestors in the report
reportsApp.getReport('my-report-id').setOptions({
    always_show_group_ancestors: false
});

Arguments

  • options object

    • always_show_group_ancestors boolean

      Specifies whether or not to display the ancestor rows for the current group.

    • columns array[object]

      A list of columns that should be shown in the report interface.

      See Columns Reference for Large Group Reporting for all column definitions.

    • user_columns array[object]

      A list of the user-level columns that should be shown in the report interface.

      See Columns Reference for Large Group Reporting for all column definitions.

Return value

None (undefined).

Was this article helpful?

Did you arrive here by accident? If so, learn more about Learnosity.