Struct ContributionGraph 

pub struct ContributionGraph { /* private fields */ }

A builder struct for generating GitHub-style contribution graphs.

Implementations

impl ContributionGraph

pub fn new() -> Self

Creates a new ContributionGraph builder with default settings.

pub fn with_data(self, data: HashMap<NaiveDate, u32>) -> Self

Sets the contribution data for the graph.

The data is a mapping from NaiveDate to a contribution count (u32).

pub fn start_date(self, date: NaiveDate) -> Self

Sets the start date for the graph.

If not provided, it defaults to the earliest date in the data or January 1st of the current year.

pub fn end_date(self, date: NaiveDate) -> Self

Sets the end date for the graph.

If not provided, it defaults to the latest date in the data or December 31st of the current year.

pub fn box_size(self, size: u32) -> Self

Sets the size of each contribution box in pixels.

pub fn gap(self, gap: u32) -> Self

Sets the gap between contribution boxes in pixels.

pub fn margin(self, margin: u32) -> Self

Sets the margin around the entire grid in pixels.

pub fn theme(self, palette: Palette) -> Self

Sets a predefined or custom Palette.

Example

use contribution_grid::{ContributionGraph, Theme, LinearStrategy, Palette, ThresholdStrategy};
use image::Rgba;

// Using a built-in theme
let graph = ContributionGraph::new()
    .theme(Theme::github(LinearStrategy));

// Using a custom palette with thresholds
let custom_palette = Palette::new(
    vec![
        Rgba([20, 20, 20, 255]),
        Rgba([0, 255, 0, 255]),
        Rgba([0, 0, 255, 255]),
    ],
    ThresholdStrategy::new(vec![1, 10])
);

let graph = ContributionGraph::new()
    .theme(custom_palette);

pub fn background_color(self, color: Rgba<u8>) -> Self

Sets the background color of the image.

pub fn round_corners(self, round: bool) -> Self

Sets whether the contribution boxes should have rounded corners.

pub fn calculate_date_range(&self) -> (NaiveDate, NaiveDate)

Calculates the effective start and end dates for the graph.

pub fn calculate_dimensions( &self, start: NaiveDate, end: NaiveDate, ) -> (u32, u32)

Calculates the dimensions (width, height) of the resulting image.

pub fn get_coordinates(&self, date: NaiveDate, start: NaiveDate) -> (i32, i32)

Calculates the (x, y) coordinates for a given date relative to the start date.

pub fn generate(&self) -> ImageBuffer<Rgba<u8>, Vec<u8>>

Generates the contribution graph image based on the current configuration.

Trait Implementations

impl Default for ContributionGraph

fn default() -> Self

Returns the “default value” for a type.