> ## Documentation Index
> Fetch the complete documentation index at: https://www.propeldata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Leaderboard

> Display ranked aggregate data.

<div />

<Tabs>
  <Tab title="Preview">
    <iframe
      width="100%"
      height="365"
      src="https://ui-kit-docs-examples.vercel.app/leaderboard"
      allow="accelerometer; clipboard-write; gyroscope;"
      style={{
      overflow: 'hidden',
      border: '1px solid #ECECED',
    }}
      scrolling="no"
      marginWidth="0"
      marginHeight="0"
    />
  </Tab>

  <Tab title="Code">
    ```jsx /leaderboard/page.tsx theme={"system"}
    import {
      Leaderboard,
      Container,
      RelativeTimeRange,
      Sort
    } from "@propeldata/ui-kit";

    export default async function LeaderboardExample() {
      return (
        <Container p="5">
          <Leaderboard
            query={{
              metric: {
                count: {
                  dataPool: {
                    name: "TacoSoft Demo Data",
                  },
                },
              },
              timeRange: { relative: RelativeTimeRange.LastNDays, n: 90 },
              rowLimit: 5,
              dimensions: [{ columnName: "restaurant_name" }],
              sort: Sort.Desc,
            }}
            chartProps={{ showBarValues: true }}
          />
        </Container>
      );
    }
    ```
  </Tab>
</Tabs>

<div className="flex justify-center gap-8 mt-2">
  <a href="https://github.com/propeldata/ui-kit/blob/main/packages/ui-kit/src/components/Leaderboard/Leaderboard.tsx" target="_blank" className="flex items-center gap-2 text-xs">
    <Icon icon="github" size={18} />

    GitHub

    <Icon icon="arrow-up-right-from-square" size={12} />
  </a>

  <a href="https://storybook.propeldata.com/?path=/story/components-leaderboard--single-dimension-bar-story" target="_blank" className="flex items-center gap-2 text-xs">
    <Icon icon="book" size={18} />

    Storybook

    <Icon icon="arrow-up-right-from-square" size={12} />
  </a>

  <a href="https://github.com/propeldata/ui-kit-docs-examples/blob/main/src/app/leaderboard/page.tsx" target="_blank" className="flex items-center gap-2 text-xs">
    <Icon icon="github" size={18} />

    Example

    <Icon icon="arrow-up-right-from-square" size={12} />
  </a>
</div>

## Examples

## Props API

<ParamField path="query" type={`LeaderboardQueryProps`}>
  Leaderboard query props

  <Expandable title="LeaderboardQueryProps">
    <ParamField path="rowLimit" type={`number`}>
      The number of rows to be returned. It can be a number between 1 and 1,000
    </ParamField>

    <ParamField path="sort" type={`Sort`}>
      The sort order of the rows. It can be ascending (ASC) or descending (DESC) order. Defaults to descending (DESC) order when not provided.

      <Expandable title="Sort">
        The available sort orders.

        <ParamField path=" ">
          * `ASC`: Sort in ascending order.
          * `DESC`: Sort in descending order.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField path="dimensions" type={`DimensionInput[]`}>
      One or many Dimensions to group the Metric values by. Typically, Dimensions in a leaderboard are what you want to compare and rank.

      <Expandable title="DimensionInput">
        The fields for creating or modifying a Dimension.

        <ParamField path="columnName" type="String" required>
          The name of the column to create the Dimension from.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField path="timeZone" type={`string`}>
      Indicates specific time zone region
    </ParamField>

    <ParamField path="timeRange" type={`TimeRangeInput`}>
      Specify the time range for a time series, counter, or leaderboard Metric query

      <Expandable title="TimeRangeInput">
        The fields required to specify the time range for a time series, counter, or leaderboard Metric query.

        If no relative or absolute time ranges are provided, Propel defaults to an absolute time range beginning with the earliest record in the Metric's Data Pool and ending with the latest record.

        If both relative and absolute time ranges are provided, the relative time range will take precedence.

        If a `LAST_N` relative time period is selected, an `n` ≥ 1 must be provided. If no `n` is provided or `n` \< 1, a `BAD_REQUEST` error will be returned.

        <ParamField path="timestamp" type="String">
          The timestamp field to use when querying. Defaults to the timestamp configured on the Data Pool or Metric, if any.
          Set this to filter on an alternative timestamp field.
        </ParamField>

        <ParamField path="relative" type="RelativeTimeRange">
          The relative time period.

          <Expandable title="RelativeTimeRange">
            The Relative time ranges are based on the current date and time.

            `THIS` - The current unit of time. For example, if today is June 8, 2022, and
            `THIS_MONTH` is selected, then data for June 2022 would be returned.

            `PREVIOUS` - The previous unit of time. For example, if today is June 8, 2022, and
            `PREVIOUS_MONTH` is selected, then data for May 2022 would be returned. It excludes
            the current unit of time.

            `NEXT` - The next unit of time. For example, if today is June 8, 2022, and
            `NEXT_MONTH` is selected, then data for July 2022 would be returned. It excludes
            the current unit of time.

            `LAST_N` - The last `n` units of time, including the current one. For example, if today
            is June 8, 2022 and `LAST_N_YEARS` with `n` = 3 is selected, then data for 2020, 2021, and
            2022 will be returned. It will include the current time period.

            <ParamField path=" ">
              * `THIS_HOUR`: Starts at the zeroth minute of the current hour and continues for 60 minutes.
              * `TODAY`: Starts at 12:00:00 AM of the current day and continues for 24 hours.
              * `THIS_WEEK`: Starts on Monday, 12:00:00 AM of the current week and continues for seven days.
              * `THIS_MONTH`: Starts at 12:00:00 AM on the first day of the current month and continues for the duration of the month.
              * `THIS_QUARTER`: Starts at 12:00:00 AM on the first day of the current calendar quarter and continues for the duration of the quarter.
              * `THIS_YEAR`: Starts on January 1st, 12:00:00 AM of the current year and continues for the duration of the year.
              * `PREVIOUS_HOUR`: Starts at the zeroth minute of the previous hour and continues for 60 minutes.
              * `YESTERDAY`: Starts at 12:00:00 AM on the day before the today and continues for 24 hours.
              * `PREVIOUS_WEEK`: Starts on Monday, 12:00:00 AM, a week before the current week, and continues for seven days.
              * `PREVIOUS_MONTH`: Starts at 12:00:00 AM on the first day of the month before the current month and continues for the duration of the month.
              * `PREVIOUS_QUARTER`: Starts at 12:00:00 AM on the first day of the calendar quarter before the current quarter and continues for the duration of the quarter.
              * `PREVIOUS_YEAR`: Starts on January 1st, 12:00:00 AM, the year before the current year, and continues for the duration of the year.
              * `NEXT_HOUR`:  Starts at the zeroth minute of the next hour and continues for 60 minutes.
              * `TOMORROW`: " Starts at 12:00:00 AM, the day after the current day, and continues for 24 hours.
              * `NEXT_WEEK`: Starts on Monday, 12:00:00 AM, the week after the current week, and continues for the duration of the week.
              * `NEXT_MONTH`: Starts at 12:00:00 AM on the first day of the next month and continues for the duration of the month.
              * `NEXT_QUARTER`: Starts at 12:00:00 AM on the first day of the next calendar quarter and continues for the duration of the quarter.
              * `NEXT_YEAR`: Starts on January 1st, 12:00:00 AM of the next year and continues for the duration of the year.
              * `LAST_N_MINUTES`: Starts at the zeroth second `n` - 1 minute(s) before the current minute and continues through the current minute. It includes this minute.
              * `LAST_N_HOURS`: Starts at the zeroth minute of the `n` - 1 hour(s) before the current hour, and continues through the current hour. It includes this hour.
              * `LAST_N_DAYS`: Starts at 12:00:00 AM, `n` - 1 day(s) before the current day, and continues through the current day. It includes today.
              * `LAST_N_WEEKS`: Starts on Monday, 12:00:00 AM, `n` - 1 week(s) before the current week, and continues through the current week. It includes this week.
              * `LAST_N_MONTHS`: Starts at 12:00:00 AM on the first day of the month, `n` - 1 month(s) before the current month, and continues through the current month. It includes this month.
              * `LAST_N_QUARTERS`: Starts at 12:00:00 AM on the first day of the calendar quarter `n` - 1 quarter(s) before the current quarter and continues through the current quarter. It includes this quarter.
              * `LAST_N_YEARS`: Starts on January 1st, 12:00:00 AM of the year `n` - 1 year(s) before the current year and continues through the current year. It includes this year.
              * `LAST_15_MINUTES`
              * `LAST_30_MINUTES`
              * `LAST_HOUR`
              * `LAST_4_HOURS`
              * `LAST_12_HOURS`
              * `LAST_24_HOURS`
              * `LAST_7_DAYS`
              * `LAST_30_DAYS`
              * `LAST_90_DAYS`
              * `LAST_3_MONTHS`
              * `LAST_6_MONTHS`
              * `LAST_YEAR`
              * `LAST_2_YEARS`
              * `LAST_5_YEARS`
            </ParamField>
          </Expandable>
        </ParamField>

        <ParamField path="n" type="Int">
          The number of time units for the `LAST_N` relative periods.
        </ParamField>

        <ParamField path="start" type="DateTime">
          The optional start timestamp (inclusive). Defaults to the timestamp of the earliest record in the Data Pool.
        </ParamField>

        <ParamField path="stop" type="DateTime">
          The optional end timestamp (exclusive). Defaults to the timestamp of the latest record in the Data Pool.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField path="metric" type={`string | DeepPartial<MetricInput>`}>
      The `metric` prop allows you to specify which metric to query.
      You can query predefined metrics by passing their name or ID as a string, or
      you can query metrics on-the-fly by passing an inline metric definition to the prop.
    </ParamField>

    <ParamField path="filters" type={`FilterInput[]`}>
      Filters that the chart will respond to

      <Expandable title="FilterInput">
        The fields of a filter.

        You can construct more complex filters using `and` and `or`. For example, to construct a filter equivalent to

        ```
        (value > 0 AND value <= 100) OR status = "confirmed"
        ```

        you could write

        ```
        {
          "column": "value",
          "operator": "GREATER_THAN",
          "value": "0",
          "and": [{
            "column": "value",
            "operator": "LESS_THAN_OR_EQUAL_TO",
            "value": "0"
          }],
          "or": [{
            "column": "status",
            "operator": "EQUALS",
            "value": "confirmed"
          }]
        }
        ```

        Note that `and` takes precedence over `or`.

        <ParamField path="column" type="String" required>
          The name of the column to filter on.
        </ParamField>

        <ParamField path="operator" type="FilterOperator" required>
          The operation to perform when comparing the column and filter values.

          <Expandable title="FilterOperator">
            The available Filter operators.

            <ParamField path=" ">
              * `EQUALS`:  Selects values that are equal to the specified value.
              * `NOT_EQUALS`:  Selects values that are not equal to the specified value.
              * `GREATER_THAN`:  Selects values that are greater than the specified value.
              * `GREATER_THAN_OR_EQUAL_TO`:  Selects values that are greater or equal to the specified value.
              * `LESS_THAN`:  Selects values that are less than the specified value.
              * `LESS_THAN_OR_EQUAL_TO`:  Selects values that are less or equal to the specified value.
              * `IS_NULL`:  Selects values that are null. This operator does not accept a value.
              * `IS_NOT_NULL`:  Selects values that are not null. This operator does not accept a value.
              * `LIKE`:  Selects values that match the specified pattern.
              * `NOT_LIKE`:  "Selects values that do not match the specified pattern.
            </ParamField>
          </Expandable>
        </ParamField>

        <ParamField path="value" type="String">
          The value to compare the column to.
        </ParamField>

        <ParamField path="and" type="[FilterInput!]">
          Additional filters to AND with this one. AND takes precedence over OR.
        </ParamField>

        <ParamField path="or" type="[FilterInput!]">
          Additional filters to OR with this one. AND takes precedence over OR.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField path="accessToken" type={`string`}>
      Access token used for the query. While you can pass this one to each component, we recommend wrapping components in the `AccessTokenProvider` instead:
    </ParamField>

    <ParamField path="refetchInterval" type={`number`}>
      Interval in milliseconds for refetching the data
    </ParamField>

    <ParamField path="retry" type={`boolean`}>
      Whether to retry on errors.
    </ParamField>

    <ParamField path="propelApiUrl" type={`string`}>
      This prop allows you to override the URL for Propel's GraphQL API. You shouldn't need to set this unless you are testing.
    </ParamField>

    <ParamField path="enabled" type={`boolean`}>
      When false, the component will not make any GraphQL requests, default is true.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField path="variant" type={`LeaderboardChartVariant`}>
  The variant the chart will respond to, can be either `bar` or `table`

  <Expandable title="LeaderboardChartVariant">
    <ParamField path="LeaderboardChartVariant" type={`"bar" | "table"`} />
  </Expandable>
</ParamField>

<ParamField path="headers" type={`string[]`}>
  If passed along with `rows` the component will ignore the built-in GraphQL operations
</ParamField>

<ParamField path="rows" type={`string[][]`}>
  If passed along with `headers` the component will ignore the built-in GraphQL operations
</ParamField>

<ParamField path="loading" type={`boolean`}>
  When true, shows a skeleton loader
</ParamField>

<ParamField path="timeZone" type={`string`}>
  Time zone to use (for example, "America/Los\_Angeles", "Europe/Berlin", or "UTC"). Defaults to the client's local time zone
</ParamField>

<ParamField path="tableProps" type={`LeaderboardTableProps`}>
  Optional props that are used to configure the table component.

  <Expandable title="LeaderboardTableProps">
    <ParamField path="stickyHeader" type={`boolean`}>
      Whether the table header should remain fixed while scrolling
    </ParamField>

    <ParamField path="stickyValues" type={`boolean`}>
      Stick the values column on the right side of the table
    </ParamField>

    <ParamField path="hasValueBar" type={`boolean`}>
      Whether the table shows a value bar. It will not show the value bar if the values are non-numeric.
    </ParamField>

    <ParamField path="localize" type={`boolean`}>
      When true, formats value to locale string
    </ParamField>

    <ParamField path="prefixValue" type={`string`}>
      Symbol to be shown before the value text
    </ParamField>

    <ParamField path="sufixValue" type={`string`}>
      Symbol to be shown after the value text
    </ParamField>
  </Expandable>
</ParamField>

<ParamField path="chartProps" type={`LeaderboardChartProps`}>
  Optional props that are used to configure the chart component. Only used when `variant` is "bar".

  <Expandable title="LeaderboardChartProps">
    <ParamField path="showBarValues" type={`boolean`}>
      Whether the chart should show a value inside the bar
    </ParamField>

    <ParamField path="labelPosition" type={`"axis" | "inside" | "top"`}>
      Sets the position of the labels
    </ParamField>
  </Expandable>
</ParamField>

<ParamField path="accentColors" type={`(AccentColors | string)[]`}>
  A list of accent colors the Leaderboard component will use, those will be picked in order
</ParamField>

<ParamField path="chartConfigProps" type={`(config: ChartConfiguration<"bar">) => ChartConfiguration<"bar">`}>
  An optional prop that provides access to the Chart.js API, allowing for further customization of chart settings.
</ParamField>

<ParamField path="prettifyHeaders" type={`boolean`}>
  Whether the headers should be prettified
</ParamField>

<Expandable title="Theme Provider Props">
  <ParamField path="appearance" type={`ThemeAppearances`}>
    The initial theme used as a base. It provides a default set of styling
    from which customizations can be applied.

    <Expandable title="ThemeAppearances">
      <ParamField path="ThemeAppearances" type={`"light" | "dark"`} />
    </Expandable>
  </ParamField>

  <ParamField path="accentColor" type={`AccentColors`}>
    The global theme accent color. This color is used to highlight elements

    <Expandable title="AccentColors">
      <ParamField path="AccentColors" type={`"amber" | "blue" | "bronze" | "brown" | "crimson" | "cyan" | "gold" | "grass" | "gray" | "green" | "indigo" | "iris" | "jade" | "lime" | "mint" | "orange" | "pink" | "plum" | "purple" | "red" | "ruby" | "sky" | "teal" | "tomato" | "violet" | "yellow"`} />
    </Expandable>
  </ParamField>

  <ParamField path="grayColor" type={`GrayColors`}>
    The global theme gray color. This color is used for text and background colors

    <Expandable title="GrayColors">
      <ParamField path="GrayColors" type={`"auto" | "gray" | "mauve" | "slate" | "sage" | "olive" | "sand"`} />
    </Expandable>
  </ParamField>

  <ParamField path="radius" type={`Radii`}>
    The global theme radius color. This color is used for border radius

    <Expandable title="Radii">
      <ParamField path="Radii" type={`"none" | "small" | "medium" | "large" | "full"`} />
    </Expandable>
  </ParamField>

  <ParamField path="scaling" type={`Scalings`}>
    The global theme scaling. This value is used to scale components

    <Expandable title="Scalings">
      <ParamField path="Scalings" type={`"90%" | "95%" | "100%" | "105%" | "110%"`} />
    </Expandable>
  </ParamField>

  <ParamField path="panelBackground" type={`PanelBackgrounds`}>
    The global theme panel background. This value is used to set the panel background

    <Expandable title="PanelBackgrounds">
      <ParamField path="PanelBackgrounds" type={`"solid" | "translucent"`} />
    </Expandable>
  </ParamField>
</Expandable>

<Expandable title="Deprecated Fields">
  <ParamField
    path="error"
    type={`{
title: string;
body: string;
} | null`}
    deprecated
  >
    This type is deprecated, use `errorFallbackProps` and `errorFallback` instead
  </ParamField>

  <ParamField path="labelFormatter" type={`(labels: LeaderboardLabels) => LeaderboardLabels`} deprecated>
    Format function for labels, must return an array with the new labels the type is deprecated, use `chartConfigProps` instead.
  </ParamField>
</Expandable>