Modrinth/docs/components/analytics.md
Adrian O.V c056c4e79e
Improved graphs (#120)
* Complete chart overhaul

* Update package.json

* Update pnpm-lock.yaml

* run lint

* whoops

* Update pnpm-lock.yaml

* Update analytics.md

* Try again?

* Update Chart.vue

* Added Compact/Spark charts

* Added number formatting and cleanup

* Touch ups

* improve default colors

* removed unnecessary tooltip
2023-10-26 11:39:26 -07:00

5.8 KiB

Analytics

Slot for title stuff Slot for toolbar stuff
<Chart
  name="Chart name"
  :labels="['array', 'of', 'labels', 'for', 'x-axis', 'typically', 'dates']"
  :data="[
      {
        name: 'Spirit',
        data: ['array', 'of', 'data', 'equal', 'length', 'to', 'x-axis'],
      },
      ...
    ]"
  :colors="['array', 'of', 'colors', 'for', 'each', 'series/dataset']"
  prefix="string or svg icon to append to each data point"
  suffix="string or svg icon to append to each data point"
  type="bar|line"
  :stacked="true|false (default: false) (determines whether or not values overlap/sidebyside instead of stacked)"
  :hideTotal="true|false (default: false) (hide total value in tooltip)"
  :hideToolbar="true|false (default: false) (hide toolbar)"
  :hideLegend="true|false (default: false) (hide legend)"
>
  ... slot for title stuff
  <template #toolbar>
    ... slot for toolbar stuff
  </template>
</Chart>
<CompactChart
  title="Chart title"
  value="Chart value"
  :labels="['array', 'of', 'labels', 'for', 'x-axis', 'typically', 'dates']"
  :data="[
      {
        name: 'Spirit',
        data: ['array', 'of', 'data', 'equal', 'length', 'to', 'x-axis'],
      },
      ...
  ]"
  prefix="string or svg icon to append to each data point"
  suffix="string or svg icon to append to each data point"
/>