Thème
Superviseur — Frontend / features/reports/useReports / useReports
Fonction: useReports()
ts
function useReports(): object;Défini dans: features/reports/useReports.ts:23
Logique de la vue Rapports : sélection des sections et de la période, génération et export, gestion des modèles et de l'archive des rapports générés. Extrait de ReportsView.vue pour séparer le comportement du gabarit.
Retourne
| Nom | Type | Description | Défini dans |
|---|---|---|---|
inputClass | string | - | features/reports/useReports.ts:266 |
primaryBtnClass | string | - | features/reports/useReports.ts:267 |
secondaryBtnClass | string | - | features/reports/useReports.ts:268 |
pagerBtnClass | string | - | features/reports/useReports.ts:269 |
activeTab | Ref<"generate" | "archive" | "automation", "generate" | "archive" | "automation"> | - | features/reports/useReports.ts:270 |
tabs | ComputedRef<( | { key: "generate"; label: string; icon: string; } | { key: "archive"; label: string; icon: string; } | { key: "automation"; label: string; icon: string; })[]> | - | features/reports/useReports.ts:271 |
allSections | ReportSectionKey[] | - | features/reports/useReports.ts:272 |
selected | object | - | features/reports/useReports.ts:273 |
selected.Centrales | boolean | - | |
selected.Utilisateurs | boolean | - | |
selected.Consignes | boolean | - | |
selected.Evenements | boolean | - | |
selected.StatsModbus | boolean | - | |
startDate | Ref<Date | null, Date | null> | - | features/reports/useReports.ts:274 |
endDate | Ref<Date | null, Date | null> | - | features/reports/useReports.ts:275 |
language | Ref<string, string> | - | features/reports/useReports.ts:276 |
eventSearch | Ref<string, string> | - | features/reports/useReports.ts:277 |
eventType | Ref<"error" | "warning" | "info" | "all", "error" | "warning" | "info" | "all"> | - | features/reports/useReports.ts:278 |
templateName | Ref<string, string> | - | features/reports/useReports.ts:279 |
dateDisplayFormat | ComputedRef<"MM/dd/yyyy" | "dd/MM/yyyy"> | - | features/reports/useReports.ts:280 |
hasSelection | ComputedRef<boolean> | - | features/reports/useReports.ts:281 |
handleGenerate() | () => Promise<void> | - | features/reports/useReports.ts:282 |
templateColumns | DataTableColumn<ReportTemplateDto>[] | - | features/reports/useReports.ts:283 |
templateOptions | ComputedRef<object[]> | - | features/reports/useReports.ts:284 |
handleSaveTemplate() | () => Promise<void> | - | features/reports/useReports.ts:285 |
applyTemplate() | (tpl) => void | - | features/reports/useReports.ts:286 |
handleDeleteTemplate() | (tpl) => Promise<void> | - | features/reports/useReports.ts:287 |
onSearchInput() | () => void | - | features/reports/useReports.ts:288 |
reloadArchive() | () => void | - | features/reports/useReports.ts:289 |
totalPages | ComputedRef<number> | - | features/reports/useReports.ts:290 |
changePage() | (delta) => void | - | features/reports/useReports.ts:291 |
handleDelete() | (r) => Promise<void> | - | features/reports/useReports.ts:292 |
previewed | Ref< | { id: string; fileName: string; createdAt: string; format: string; sizeBytes: number; origin: string; sections: string[]; frequency?: string | null; periodStart?: string | null; periodEnd?: string | null; } | null, | GeneratedReportDto | { id: string; fileName: string; createdAt: string; format: string; sizeBytes: number; origin: string; sections: string[]; frequency?: string | null; periodStart?: string | null; periodEnd?: string | null; } | null> | Rapport actuellement ouvert dans la visionneuse, ou null si elle est fermée. | features/reports/useReports.ts:293 |
isViewable() | (r) => boolean | Vrai pour un rapport que la visionneuse sait rendre : le CSV n'a rien à montrer. | features/reports/useReports.ts:294 |
openPreview() | (r) => void | - | features/reports/useReports.ts:295 |
closePreview() | () => void | - | features/reports/useReports.ts:296 |
loadPreview() | () => Promise<Blob> | Fournit à la visionneuse le contenu du rapport ouvert. | features/reports/useReports.ts:297 |
downloadPreviewed() | () => Promise<void> | Enregistre sur le poste le rapport que l'opérateur consulte. | features/reports/useReports.ts:298 |
updateSchedule() | (key, value) => Promise<void> | - | features/reports/useReports.ts:299 |
formatSize() | (bytes) => string | - | features/reports/useReports.ts:300 |
formatDate() | (iso) => string | - | features/reports/useReports.ts:301 |
store | Store<"reports", Pick<{ items: Ref<object[], | GeneratedReportDto[] | object[]>; total: Ref<number, number>; search: Ref<string, string>; page: Ref<number, number>; pageSize: Ref<number, number>; loadingArchive: Ref<boolean, boolean>; templates: Ref<object[], | ReportTemplateDto[] | object[]>; generating: Ref<boolean, boolean>; schedule: ComputedRef<ReportSchedule>; exportingDatabase: Ref<boolean, boolean>; fetchArchive: () => Promise<void>; generate: (request) => Promise<void>; download: (report) => Promise<void>; downloadDatabaseExport: (format) => Promise<void>; remove: (id) => Promise<void>; fetchTemplates: () => Promise<void>; saveTemplate: (template) => Promise<ReportTemplateDto>; removeTemplate: (id) => Promise<void>; updateSchedule: (patch) => Promise<void>; }, | "search" | "total" | "generating" | "items" | "page" | "pageSize" | "loadingArchive" | "templates" | "exportingDatabase">, Pick<{ items: Ref<object[], | GeneratedReportDto[] | object[]>; total: Ref<number, number>; search: Ref<string, string>; page: Ref<number, number>; pageSize: Ref<number, number>; loadingArchive: Ref<boolean, boolean>; templates: Ref<object[], | ReportTemplateDto[] | object[]>; generating: Ref<boolean, boolean>; schedule: ComputedRef<ReportSchedule>; exportingDatabase: Ref<boolean, boolean>; fetchArchive: () => Promise<void>; generate: (request) => Promise<void>; download: (report) => Promise<void>; downloadDatabaseExport: (format) => Promise<void>; remove: (id) => Promise<void>; fetchTemplates: () => Promise<void>; saveTemplate: (template) => Promise<ReportTemplateDto>; removeTemplate: (id) => Promise<void>; updateSchedule: (patch) => Promise<void>; }, "schedule">, Pick<{ items: Ref<object[], | GeneratedReportDto[] | object[]>; total: Ref<number, number>; search: Ref<string, string>; page: Ref<number, number>; pageSize: Ref<number, number>; loadingArchive: Ref<boolean, boolean>; templates: Ref<object[], | ReportTemplateDto[] | object[]>; generating: Ref<boolean, boolean>; schedule: ComputedRef<ReportSchedule>; exportingDatabase: Ref<boolean, boolean>; fetchArchive: () => Promise<void>; generate: (request) => Promise<void>; download: (report) => Promise<void>; downloadDatabaseExport: (format) => Promise<void>; remove: (id) => Promise<void>; fetchTemplates: () => Promise<void>; saveTemplate: (template) => Promise<ReportTemplateDto>; removeTemplate: (id) => Promise<void>; updateSchedule: (patch) => Promise<void>; }, | "remove" | "generate" | "download" | "saveTemplate" | "fetchArchive" | "downloadDatabaseExport" | "fetchTemplates" | "removeTemplate" | "updateSchedule">> | - | features/reports/useReports.ts:302 |