analytica-frontend-lib
Version:
Repositório público dos componentes utilizados nas plataformas da Analytica Ensino
44 lines • 1.46 kB
TypeScript
/**
* Performance tag types based on percentage ranges
*/
export declare enum PerformanceTag {
DESTAQUE_DA_TURMA = "DESTAQUE_DA_TURMA",
ACIMA_DA_MEDIA = "ACIMA_DA_MEDIA",
ABAIXO_DA_MEDIA = "ABAIXO_DA_MEDIA",
PONTO_DE_ATENCAO = "PONTO_DE_ATENCAO"
}
/**
* Performance tag configuration
*/
export interface PerformanceTagConfig {
label: string;
variant: 'success' | 'info' | 'warning' | 'error';
minPercentage: number;
maxPercentage: number;
}
/**
* Time intervals accepted by backend API
* Used as query parameter in analytics endpoints
*/
export type TimeInterval = '1week' | '15days' | '1month' | '6months' | '1year';
/**
* Performance tag configurations by type
* 90-100%: Destaque da turma (success)
* 70-89%: Acima da média (info)
* 40-69%: Abaixo da média (warning)
* 0-39%: Ponto de atenção (error)
*/
export declare const PERFORMANCE_TAG_CONFIG: Record<PerformanceTag, PerformanceTagConfig>;
/**
* Get performance tag based on percentage
* @param percentage - Performance percentage (0-100)
* @returns Performance tag type
*/
export declare function getPerformanceTag(percentage: number): PerformanceTag;
/**
* Get performance tag configuration based on percentage
* @param percentage - Performance percentage (0-100)
* @returns Performance tag configuration
*/
export declare function getPerformanceTagConfig(percentage: number): PerformanceTagConfig;
//# sourceMappingURL=performance.d.ts.map