OBJECT

ReportChart

link GraphQL Schema definition

  • type ReportChart {
  • # Whether a chart is shown for this report tab.
  • isEnabled: Boolean!
  • # Visual type of the chart, such as Scorecard, Pie, Line, Column, Bar, Bubble,
  • # ScatterPlot or Sankey.
  • type: ReportChartType!
  • # Identifier of the field whose values are plotted; left empty when the chart
  • # counts records.
  • fieldId: UUID
  • # Identifier of the report box that the plotted field belongs to.
  • boxId: UUID
  • # How the plotted field's values are aggregated, such as Count, Sum, Average, Min
  • # or Max.
  • operator: AggregationOperator!
  • # Identifier of the field used to group values along the chart's main axis.
  • groupFieldId: UUID
  • # Identifier of the report box that the grouping field belongs to.
  • groupBoxId: UUID
  • # How the grouping field's values are grouped, for example by month or by
  • # interval.
  • groupOption: GroupOption
  • # Identifier of the field used to split each group into separate series or
  • # segments.
  • segmentFieldId: UUID
  • # Identifier of the report box that the segment field belongs to.
  • segmentBoxId: UUID
  • # For bubble chart and scatter plot only
  • segmentFieldEnabled: Boolean
  • # How the segment field's values are grouped, for example by month or by interval.
  • segmentOption: GroupOption
  • # Whether an average line is drawn on the chart.
  • showAverage: Boolean
  • # Whether records with no value for the grouping or plotted field are shown as a
  • # not-available category.
  • showNotAvailableValues: Boolean
  • # Comparison series shown alongside the main series, such as a previous period or
  • # previous year.
  • comparison: ChartComparison
  • # Sort values in pie chart
  • sortValues: SortOrder
  • # Whether negative values are displayed on the chart.
  • showNegativeValues: Boolean!
  • # Height of the chart in pixels.
  • height: Int
  • # Whether values are labelled as percentages of the total.
  • showPercentageValues: Boolean!
  • # Whether numeric value labels are shown on the chart.
  • showNumbers: Boolean!
  • # Identifiers of the history comparison dates the chart plots, for history-based
  • # reports.
  • historyComparisonDateIds: [UUID]
  • # Whether the chart groups values by history comparison date rather than by a
  • # regular field.
  • groupByHistory: Boolean
  • # Flow definition used when the chart type is Sankey, describing the start and end
  • # grouping of records.
  • sankey: ReportSankeyChart
  • # Whether a data label is shown for every data point rather than only selected
  • # ones.
  • showAllDataLabels: Boolean!
  • # Color of the main series, given as an RGB color code encoded as an integer.
  • seriesColor: Int
  • }

link Require by