HTML & JavaScript

Vizzly offers a Custom Web Component that can be used in any modern web application. It is highly recommended to read the general introduction to the Vizzly component before using it in your application. You can find the general introduction here.

Importing Vizzly

The in-browser query engine relies on our in-memory database. You will install this by adding a script tag in the head tag of your webpage.

<html>
  <head>
    <!-- ... -->
    <meta charset="utf-8" />
 
    <!-- 
      [REQUIRED FOR IN-BROWSER ONLY]  
      If you are running Vizzly's in-browser query engine, install Vizzly's in-memory DB
    -->
    <script src="https://static.app.vizzly.co/query-engine/0.8.29/vizzly-in-memory-db.umd.js"></script>
 
    <!--
      [REQUIRED]
      Install Vizzly's components
    -->
    <script src="https://static.app.vizzly.co/embedded/0.12.13/bundle.js"></script>
  </head>
  <body>
    <!-- ... -->
  </body>
</html>

Usage

It is important that you give the component an id attribute. This is required to identify the component in your application. You can then reference the component in a script tag and call the render function to render the component.

You can pass any props to the component which are supported by the Vizzly component Props Reference.

<script type="module">
  dashboard.render({
    // Your dashboard properties go here, such as `identity`
  });
</script>
<div>
  <vizzly-dashboard id="dashboard" />
</div>

Examples

In-Browser

<script type="module">
  dashboard.render({
    dataSets: async () => {
      return [
        {
          id: "data_set_1",
          name: "My first data set",
          fields: [
            {
              dataType: "number",
              publicName: "Player age",
              id: "fie_1",
            },
            {
              dataType: "string",
              publicName: "Game",
              id: "fie_2",
            },
            {
              dataType: "number",
              publicName: "Score",
              id: "fie_3",
            },
            {
              dataType: "date_time",
              publicName: "Recorded at",
              id: "fie_4",
              allowedGranularities: ["month", "year"],
            },
          ],
        },
      ];
    },
    data: async (dataSet) => {
      if (dataSet.id == "data_set_1") {
        return [
          {
            fie_1: 16,
            fie_2: "Space invaders",
            fie_3: 54,
            fie_4: "2023-01-30T08:21:25.459Z",
          },
          {
            fie_1: 12,
            fie_2: "Space invaders",
            fie_3: 54,
            fie_4: "2023-02-13T08:21:25.459Z",
          },
          {
            fie_1: 9,
            fie_2: "Space invaders",
            fie_3: 4,
            fie_4: "2023-03-13T08:21:25.459Z",
          },
          {
            fie_1: 19,
            fie_2: "Space invaders",
            fie_3: 140,
            fie_4: "2023-04-07T08:21:25.459Z",
          },
          {
            fie_1: 90,
            fie_2: "Tetris",
            fie_3: 7,
            fie_4: "2023-03-13T08:21:25.459Z",
          },
          {
            fie_1: 73,
            fie_2: "Tetris",
            fie_3: 68,
            fie_4: "2023-04-07T08:21:25.459Z",
          },
        ];
      } else {
        throw "Unknown data set.";
      }
    },
    identity: async () => {
      const response = await fetch("<< Your identity endpoint >>");
      if (response.ok) {
        const responseBody = await response.json();
        return responseBody.accessTokens;
      }
      return null;
    },
  }
  );
</script>
<vizzly-dashboard id="dashboard" />

Query Engine

<script type="module">
  dashboard.render({
    queryEngineEndpoint: '<< The endpoint of your Vizzly query engine >>',
 
    // https://docs.vizzly.co/callbacks/identity
    identity: async () => {
      // Opens a guide... replace this when you're ready!
      throw new Error('Not implemented yet!');
    },
  });
</script>
<vizzly-dashboard id="dashboard" />

Custom

<script type="module">
  dashboard.render({
    // https://docs.vizzly.co/dashboard/properties/identity
    identity: async () => {
      // Opens a guide... replace this when you're ready!
      throw new Vizzly.NewVizzlyImplementation();
    },
 
    // https://docs.vizzly.co/dashboard/properties/runQueries
    runQueries: async (queries, params) => {
      {
        /*
      TODO: Return results for the queries, in the Result format.
      https://docs.vizzly.co/concepts/result
      */
      }
      return [];
    },
 
    // https://docs.vizzly.co/dashboard/properties/dataSets
    dataSets: async () => {
      {
        /*
      TODO: Return a list of data set schemas that are available to your
      user.
      */
      }
      return [];
    },
  });
</script>
<vizzly-dashboard id="dashboard" />