Skip to content

Superviseur — Frontend v1.0.0


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 ​

NomTypeDescriptionDéfini dans
inputClassstring-features/reports/useReports.ts:266
primaryBtnClassstring-features/reports/useReports.ts:267
secondaryBtnClassstring-features/reports/useReports.ts:268
pagerBtnClassstring-features/reports/useReports.ts:269
activeTabRef<"generate" | "archive" | "automation", "generate" | "archive" | "automation">-features/reports/useReports.ts:270
tabsComputedRef<( | { key: "generate"; label: string; icon: string; } | { key: "archive"; label: string; icon: string; } | { key: "automation"; label: string; icon: string; })[]>-features/reports/useReports.ts:271
allSectionsReportSectionKey[]-features/reports/useReports.ts:272
selectedobject-features/reports/useReports.ts:273
selected.Centralesboolean-
selected.Utilisateursboolean-
selected.Consignesboolean-
selected.Evenementsboolean-
selected.StatsModbusboolean-
startDateRef<Date | null, Date | null>-features/reports/useReports.ts:274
endDateRef<Date | null, Date | null>-features/reports/useReports.ts:275
languageRef<string, string>-features/reports/useReports.ts:276
eventSearchRef<string, string>-features/reports/useReports.ts:277
eventTypeRef<"error" | "warning" | "info" | "all", "error" | "warning" | "info" | "all">-features/reports/useReports.ts:278
templateNameRef<string, string>-features/reports/useReports.ts:279
dateDisplayFormatComputedRef<"MM/dd/yyyy" | "dd/MM/yyyy">-features/reports/useReports.ts:280
hasSelectionComputedRef<boolean>-features/reports/useReports.ts:281
handleGenerate()() => Promise<void>-features/reports/useReports.ts:282
templateColumnsDataTableColumn<ReportTemplateDto>[]-features/reports/useReports.ts:283
templateOptionsComputedRef<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
totalPagesComputedRef<number>-features/reports/useReports.ts:290
changePage()(delta) => void-features/reports/useReports.ts:291
handleDelete()(r) => Promise<void>-features/reports/useReports.ts:292
previewedRef< | { 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) => booleanVrai 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
storeStore<"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

Documentation Technique