@luzmo/react-embed v5.1.6

React component for Luzmo

This is a React library for embedding Luzmo dashboards in your React application.

Table of contents

1. Installation instructions
2. Luzmo viz item
3. Luzmo Dashboard
4. Changelog
5. Migration
6. Quick links

Installation instructions

npm i @luzmo/react-embed

Luzmo viz item

For a more comprehensive documentation visit Flex SDK Docs - Luzmo Developer Docs

Usage

import { LuzmoVizItemComponent } from '@luzmo/react-embed';
import { useRef } from 'react';
...
  function LuzmoWrapper() {
    const ref = useRef<any>(null);
    return (
      <div className="App">
        <button
          onClick={(e) => console.log(ref.current.export())}
        >
          Export Dashboard
        </button>
        <LuzmoVizItemComponent
          ref={ref}
          authKey="<!-- your generated authKey -->"
          authToken="<!-- your generated authToken -->"
          type="bar-chart"
          load={(e) => console.log('load', e)}
        </LuzmoVizItemComponent>
      </div>
    );
  }
...

Properties: LuzmoVizItemComponent

Below a list of available properties on the viz item web component

Events LuzmoVizItemComponent

Public methods LuzmoVizItemComponent

getData(): any
// Return an array of the data of the viz item that's embedded.

getFilters(): FilterGroup[];
// Return an array of active filters on the viz item.

refreshData(): void
// Refresh the data of the viz item.

setAuthorization(key: string, token: string): void
// Changes the authorization of the viz item. To fetch data based on new authorization parameters, refreshData() needs to be called.

export(): void
// Export the viz item as png.

Luzmo Dashboard

Usage

import { LuzmoDashboardComponent, LuzmoDashboard } from '@luzmo/react-embed';
import { useRef } from 'react';
...
  function LuzmoWrapper() {
    const ref = useRef<LuzmoDashboard>(null);
    return (
      <div className="App">
        <button
          onClick={async (e) => console.log(await ref.current.exportDashboard())}
        >
          Export Dashboard
        </button>
        <LuzmoDashboardComponent
          ref={ref}
          authKey="<!-- your generated authKey -->"
          authToken="<!-- your generated authToken -->"
          dashboardSlug="test"
          switchScreenModeOnResize={false}
          loaderSpinnerColor="rgb(0, 81, 126)"
          loaderSpinnerBackground="rgb(236 248 255)"
          itemsRendered={(e) => console.log('itemsRendered', e)}>
        </LuzmoDashboardComponent>
      </div>
    );
  }
...

Properties

Below a list of available properties on the dashboard react component

Events

Public methods

getDashboards(): Promise<LuzmoDashboard[]>
// Returns an instantly resolved promise with an array of all the visible dashboards on a page with their information.

getData(itemId: string): Promise<ItemData>
// Promise that returns an array with the data of a item.

getFilters(): Promise<FilterGroup[]>
// Promise that returns an array of filters.

setAuthorization(key: string, token: string): Promise<void>
// Changes the authorization of all or one dashboard. To fetch data based on new authorization parameters, reloadDashboard() or refreshData() needs to be called.

refreshData(itemId?: string): Promise<void>
// Refreshes the data of a specific item/chart when the id of that item is supplied. Without a itemId this refreshes the data in all items.

reloadDashboard(): Promise<void>
// Reloads the dashboard. (useful when the authorization is changed, and dashboard needs to be reloaded)

exportDashboard(type?: ExportType): Promise<ExportDashboard>
// Exports the current dashboard as either pdf or png.

getAccessibleDashboards(): Promise<AccessibleDashboard[]>
// Retrieves a list of all dashboards an integration has access to. authKey and authToken needs to be set for this function to work.

setEditMode(editMode: string): Promise<SetEditMode>
// Sets the editMode of the current dashboard. Accepted parameters: view , editLimited , editFull .

Changelog

• Changelog

Migration

Migrating from cumul.io to luzmo.

• Change import '@cumul.io/react-cumulio-dashboard to import @luzmo/react-embed.
• Replace all references of Cumulio to Luzmo.
• Replace CumulioDashboardComponent to LuzmoDashboardComponent.
• Replace CumulioDashboard to LuzmoDashboard.

Quick links

Luzmo | Codesandbox example | Migrations | Changelog