react-gauge-component
Version:
Gauge component for React
48 lines (47 loc) • 1.74 kB
TypeScript
/// <reference types="react" />
export interface TickLabels {
/** Hide first and last ticks and it's values */
hideMinMax?: boolean;
/** Wheter the ticks are inside or outside the arcs */
type?: "inner" | "outer";
/** List of desired ticks */
ticks?: Array<Tick>;
/** Default tick value label configs, this will apply to all
* ticks but the individually configured */
defaultTickValueConfig?: TickValueConfig;
/** Default tick line label configs, this will apply to all
* ticks but the individually configured */
defaultTickLineConfig?: TickLineConfig;
}
export interface Tick {
/** The value the tick will correspond to */
value?: number;
/** This will override defaultTickValueConfig */
valueConfig?: TickValueConfig;
/** This will override defaultTickLineConfig */
lineConfig?: TickLineConfig;
}
export interface TickValueConfig {
/** This function allows to customize the rendered tickValue label */
formatTextValue?: (value: any) => string;
/** This enables configuration for the number of decimal digits of the
* central value label */
maxDecimalDigits?: number;
/** The tick value label will inherit this */
style?: React.CSSProperties;
/** If true will hide the tick value label */
hide?: boolean;
}
export interface TickLineConfig {
/** The width of the tick's line */
width?: number;
/** The length of the tick's line */
length?: number;
/** The distance of the tick's line from the arc */
distanceFromArc?: number;
/** The color of the tick's line */
color?: string;
/** If true will hide the tick line */
hide?: boolean;
}
export declare const defaultTickLabels: TickLabels;