Types for Luzmo dashboard contents

This packages contains different TypeScript types and JSON schemas for Luzmo dashboard contents.

Content Item Types

Here is a list of some content item TypeScript types. Additional types are also available in the package.

| Type | Description | |--------------------------------|-------------------------------------------------------| | AreaChart | An Area Chart type. | | AreaChartViewOptions | An Area Chart options type. | | AreaChartSlots | An Area Chart slots type. | | BarChart | A Bar Chart type. | | BarChartViewOptions | A Bar Chart options type. | | BarChartSlots | A Bar Chart slots type. | | BoxPlot | A Box Plot type. | | BoxPlotViewOptions | A Box Plot options type. | | BoxPlotSlots | A Box Plot slots type. | | BubbleChart | A Bubble Chart type. | | BubbleChartViewOptions | A Bubble Chart options type. | | BubbleChartSlots | A Bubble Chart slots type. | | BulletChart | A Bullet Chart type. | | BulletChartViewOptions | A Bullet Chart options type. | | BulletChartSlots | A Bullet Chart slots type. | | ChoroplethMap | A Choropleth Map type. | | ChoroplethMapViewOptions | A Choropleth Map options type. | | ChoroplethMapSlots | A Choropleth Map slots type. | | CircularGauge | A Circular Gauge type. | | CircularGaugeViewOptions | A Circular Gauge options type. | | CircularGaugeSlots | A Circular Gauge slots type. | | ColumnChart | A Column Chart type. | | ColumnChartViewOptions | A Column Chart options type. | | ColumnChartSlots | A Column Chart slots type. | | CombinationChart | A Combination Chart type. | | CombinationChartViewOptions | A Combination Chart options type. | | CombinationChartSlots | A Combination Chart slots type. | | ConditionalNumber | A Conditional Number type. | | ConditionalNumberViewOptions | A Conditional Number options type. | | ConditionalNumberSlots | A Conditional Number slots type. | | DateFilter | A Date Filter type. | | DateFilterViewOptions | A Date Filter options type. | | DateFilterSlots | A Date Filter slots type. | | DonutChart | A Donut Chart type. | | DonutChartViewOptions | A Donut Chart options type. | | DonutChartSlots | A Donut Chart slots type. | | DropdownFilter | A Dropdown Filter type. | | DropdownFilterViewOptions | A Dropdown Filter options type. | | DropdownFilterSlots | A Dropdown Filter slots type. | | EvolutionNumber | An Evolution Number type. | | EvolutionNumberViewOptions | An Evolution Number options type. | | EvolutionNumberSlots | An Evolution Number slots type. | | FunnelChart | A Funnel Chart type. | | FunnelChartViewOptions | A Funnel Chart options type. | | FunnelChartSlots | A Funnel Chart slots type. | | HeatMap | A Heat Map type. | | HeatMapViewOptions | A Heat Map options type. | | HeatMapSlots | A Heat Map slots type. | | HexbinMap | A Hexbin Map type. | | HexbinMapViewOptions | A Hexbin Map options type. | | HexbinMapSlots | A Hexbin Map slots type. | | Image | An Image type. | | ImageViewOptions | An Image options type. | | LineChart | A Line Chart type. | | LineChartViewOptions | A Line Chart options type. | | LineChartSlots | A Line Chart slots type. | | MarkerMap | A Marker Map type. | | MarkerMapViewOptions | A Marker Map options type. | | MarkerMapSlots | A Marker Map slots type. | | PivotTable | A Pivot Table type. | | PivotTableViewOptions | A Pivot Table options type. | | PivotTableSlots | A Pivot Table slots type. | | RegularTable | A Regular Table type. | | RegularTableViewOptions | A Regular Table options type. | | RegularTableSlots | A Regular Table slots type. | | RouteMap | A Route Map type. | | RouteMapViewOptions | A Route Map options type. | | RouteMapSlots | A Route Map slots type. | | SankeyDiagram | A ScatterPlot type. | | SankeyDiagramViewOptions | A Sankey Diagram options type. | | SankeyDiagramSlots | A Sankey Diagram slots type. | | ScatterPlot | A Scatter Plot type. | | ScatterPlotViewOptions | A Scatter Plot options type. | | ScatterPlotSlots | A Scatter Plot slots type. | | SearchFilter | A Search Filter type. | | SearchFilterViewOptions | A Search Filter options type. | | SearchFilterSlots | A Search Filter slots type. | | SlicerFilter | A Slicer Filter type. | | SlicerFilterViewOptions | A Slicer Filter options type. | | SlicerFilterSlots | A Slicer Filter slots type. | | SliderFilter | A Slider Filter type. | | SliderFilterViewOptions | A Slider Filter options type. | | SliderFilterSlots | A Slider Filter slots type. | | SpikeMap | A Spike Map type. | | SpikeMapViewOptions | A Spike Map options type. | | SpikeMapSlots | A Spike Map slots type. | | SymbolMap | A Symbol Map type. | | SymbolMapViewOptions | A Symbol Map options type. | | SymbolMapSlots | A Symbol Map slots type. | | WordcloudChart | A Wordcloud Chart type. | | WordcloudChartViewOptions | A Wordcloud Chart options type. | | WordcloudChartSlots | A Wordcloud Chart slots type. | | Text | A Text type. | | TextViewOptions | A Text options type. | | Video | A Video type. | | VideoViewOptions | A Video options type. | | VizItemType | A union type for content item types. | | Options | A union type for all the options from all the charts. | | Slots | A union type for all the slots from all the charts. |

JSON Schemas

Each content item above has a corresponding JSON schema. Here’s an example of importing the JSON schema for the Bar Chart:

import { BarChartJSONSchema, BarChartOptionsJSONSchema, BarChartSlotsJSONSchema } from '@luzmo/dashboard-contents-types';

console.log(BarChartJSONSchema);
console.log(BarChartOptionsJSONSchema);
console.log(BarChartSlotsJSONSchema);

There is also an object that contains all the JSON schemas for the content items. In this object, each schema name serves as a key, with the corresponding schema as its value. Here’s an example:

import { JSON_SCHEMAS } from '@luzmo/dashboard-contents-types';

console.log(JSON_SCHEMAS);
console.log(JSON_SCHEMAS['text-options.schema.json']);

Using the JSON_SCHEMAS object will significantly increase the bundle size, so whenever possible import only the needed schemas, as demonstrated in the Bar Chart example above.