HistogramTile Documentation

Overview

The HistogramTile is a component of the Vantage analytics and data platform that visualizes data distributions using histograms. It allows users to understand the frequency distribution of a dataset by displaying how often each range of values occurs in a collection. This type of visualization is especially useful for analyzing the shape, spread, and central tendency of a dataset.

Purpose

The HistogramTile enables users to:

• Visualize data distributions effectively.
• Quickly identify trends, outliers, and patterns in data.
• Utilize both raw and AI-generated data for enhanced analytics.
• Facilitate easy navigation to detailed data sources via click-through functionality.

Data Expectations

The HistogramTile expects either:

• Raw data in the form of an array of objects, where each object has at least a label (representing the bin range) and a value (representing the frequency or count of data points in that bin).
• Data that can be referenced by a dataRefId, which is a string identifier used to pull data from a larger dataset.

Settings

The HistogramTile contains several configurable settings designed to optimize its appearance and functionality:

1. Title

• Input Type: String
• Description: The primary text displayed at the top of the tile. It provides context about the data being visualized.
• Default Value: None (must be provided).

2. Subtitle

• Input Type: String
• Description: Additional context or information displayed below the title. It can be used to elaborate on the data visualization.
• Default Value: None (optional).

3. Footer Text

• Input Type: String
• Description: Text displayed at the bottom of the tile, often used for notes or references about the data.
• Default Value: None (optional).

4. Footer Color

• Input Type: String (CSS color code)
• Description: Sets the color of the footer text. Changing this can improve visual accessibility based on the tile’s background.
• Default Value: None (optional, default is set according to theme).

5. Data

• Input Type: Array of objects
• Description: The dataset used for the histogram visualization, where each object includes label and value.
• Default Value: Empty array.

6. Data Reference IDs (dataRefIds)

• Input Type: Array of strings
• Description: Identifiers used to retrieve datasets from external sources, which can be utilized to generate the histogram when raw data is not provided.
• Default Value: Empty array.

7. Show Grid

• Input Type: Boolean
• Description: Determines whether a grid background should be shown in the histogram, improving readability of values.
• Default Value: true.

8. Show Tooltip

• Input Type: Boolean
• Description: Controls the visibility of tooltips that appear on hover, displaying additional information about specific bars in the histogram.
• Default Value: true.

9. Show Legend

• Input Type: Boolean
• Description: Indicates if a legend should be displayed, helping users understand the correlation between colors and data series.
• Default Value: true.

10. Workflows

• Input Type: Array of strings
• Description: Allows linking to specific data processing workflows that can feed data into the histogram.
• Default Value: Empty array.

11. Series

• Input Type: Array of objects
• Description: Contains configurations for data series, including attributes for each histogram bin like color and label. Each entry typically includes a label and color.
• Default Value: Empty array.

12. Skip Animation

• Input Type: Boolean
• Description: Controls whether animations should be skipped, particularly when switching between tabs for quicker transitions.
• Default Value: false.

13. Click URL

• Input Type: String
• Description: A URL to which users can navigate upon clicking the histogram. This allows for deep linking to data sources or related reports.
• Default Value: None (optional).

14. Axis Labels

• Input Type: Object
• Description: An object containing x and y properties to define custom labels for the respective axes on the histogram.
• Default Value: Object with empty strings for both axes.

Use Cases & Examples

Use Cases

1. Sales Data Analysis: A business could use the HistogramTile to analyze sales data across different product categories, helping identify which categories perform best over specific time intervals.

2. Customer Behavior Insights: A marketing team might leverage the HistogramTile to examine customer purchase frequencies based on user segments, revealing valuable insights into user behavior.

3. Quality Control: In manufacturing, companies can visualize defect rates over time or across different production lines to identify patterns and promote higher product quality.

Example Configuration

Use Case: Sales Performance Analysis

To analyze the distribution of sales across different regions during a quarter, a company can configure the HistogramTile as follows:

{
  "title": "Sales Distribution Q1",
  "subtitle": "Visualizing the frequency of sales across regions",
  "footerText": "Data sourced from Sales Analytics",
  "footerColor": "#FF5733",
  "data": [
    { "label": "Region A", "value": 150 },
    { "label": "Region B", "value": 230 },
    { "label": "Region C", "value": 80 },
    { "label": "Region D", "value": 300 },
    { "label": "Region E", "value": 120 }
  ],
  "showGrid": true,
  "showTooltip": true,
  "showLegend": true,
  "series": [
    { "label": "Sales", "color": "#4285F4" }
  ],
  "clickUrl": "https://company.com/sales/details",
  "axisLabels": {
    "x": "Regions",
    "y": "Sales Count"
  }
}

This configuration visualizes the sales distribution for Q1, providing valuable insights into regional performance and leading to informed business decisions.