SDK Reference
Views

Views

Views are the core elements in Vizzly that enable users to visualize and interact with data in various formats. They range from different types of charts to tables and maps, each designed to offer a specific view or analysis of the data.

Available Views

Vizzly offers a diverse range of views to cater to different data visualization needs:

  • Column chart: Uses bars to compare different sets of data.
  • Horizontal bar chart: Similar to a BarChart but with horizontal bars.
  • Area chart: Displays data as areas on a chart, useful for showing trends over time.
  • Line chart: Ideal for illustrating changes and trends over time with line graphs.
  • Scatter chart: Displays data points on a Cartesian plane, perfect for showing correlations.
  • Pie chart: Represents data in a circular pie-like format, useful for showing proportions.
  • Single stat: Shows a single statistical value, ideal for key data point representation.
  • Pivot table: Transforms data into a table with dynamic rows and columns.
  • Basic table: Displays data in a simple, straightforward table format.
  • Combo chart: A versatile component that combines different chart types.
  • Country map: A map component based on the Mercator projection, suitable for geographical data visualization.
  • Progress: Used to show progress towards goals, completion of tasks, or as indicators of performance metrics.

Basic Example

The following example demonstrates how to initialize a SingleStat component in Vizzly:

import { Vizzly } from "@vizzly/services;
 
new Vizzly.SingleStat(dataSets[0]);

API

/**
* Constructs a new instance of a Component class.
* @param dataSet - Pass in the dataSet to correctly define the Component
* @param attributes - (Optional) The attributes that can be changed to make up a Component
*/
constructor(
    dataSet: DataSet,
    attributes?: Partial<ComponentAttribute[<< Available Component Attributes >>]>
)
 
/**
* @param newAttributes - The attributes that can be changed to make up a Component
*/
updateAttributes(newAttributes: Partial<ComponentAttribute[T]>)
 
```shared-logic/src/Componentshared-logic/src/getComponentInterface