@rcsb/rcsb-charts/lib/RcsbChartComponent/ChartConfigInterface.d.ts

RCSB Charts

import { ChartDataColumnInterface, ChartDataValueInterface } from "../RcsbChartDataProvider/ChartDataProviderInterface";
import * as React from "react";
export interface ChartObjectInterface<T = any> {
    label: string | number;
    population: number;
    objectConfig?: {
        objectId?: T;
        color?: string;
    };
}
export type BarClickCallbackType = (datum: ChartDataValueInterface, data: ChartDataColumnInterface[], e?: React.MouseEvent<any>) => void;
export interface ChartConfigInterface {
    mostPopulatedGroups?: number;
    domainMinValue?: number;
    domainMaxValue?: number;
    domainEmptyBins?: boolean;
    histogramBinIncrement?: number;
    tickIncrement?: {
        origin: number;
        increment: number;
    };
    tickFormat?: {
        domAxis?: (x: string | number) => string;
        imgAxis?: (x: string | number) => string;
    };
    axisLabel?: string;
    barClickCallback?: BarClickCallbackType;
    sort?: (b: ChartDataColumnInterface, a: ChartDataColumnInterface) => number;
    tooltipText?: (a: ChartDataValueInterface) => string | string[] | undefined;
    chartDisplayConfig?: Partial<ChartDisplayConfigInterface>;
}
export interface ChartDisplayConfigInterface {
    paddingLeft: number;
    paddingTopLarge: number;
    paddingTop: number;
    paddingRight: number;
    constWidth: number;
    constHeight: number;
    xIncrement: number;
    xDomainPadding: number;
    barWidth: number;
    minBarLength: number;
    fontFamily: string;
    fontSize: number;
}
export declare enum ChartType {
    pie = "pie",
    histogram = "histogram",
    barplot = "barplot"
}