Adicionado documentação dos componentes de Vitruvio.
This commit is contained in:
@@ -0,0 +1,87 @@
|
||||
export type VitruvioComponentDoc = {
|
||||
component: string;
|
||||
summary: string;
|
||||
status: "draft" | "review" | "ready";
|
||||
context: {
|
||||
module: string;
|
||||
family: string;
|
||||
mappedFrom: string[];
|
||||
occurrences: {
|
||||
total: number;
|
||||
paineis: number;
|
||||
processos: number;
|
||||
};
|
||||
};
|
||||
sections: {
|
||||
purpose: string;
|
||||
basicUsage: string;
|
||||
properties: string[];
|
||||
propertyValues: { [property: string]: string[] };
|
||||
propertyValueTypes: { [property: string]: "boolean" | "enum" | "numeric" | "text" | "mixed" };
|
||||
events: string[];
|
||||
examples: string[];
|
||||
notes: string[];
|
||||
};
|
||||
};
|
||||
|
||||
const WebPivotTableWidgetDoc: VitruvioComponentDoc = {
|
||||
component: "WebPivotTableWidget",
|
||||
summary: "Documentacao do componente WebPivotTableWidget mapeada a partir de exemplos reais de XML.",
|
||||
status: "draft",
|
||||
context: {
|
||||
module: "Vitruvio",
|
||||
family: "Visualizacao",
|
||||
mappedFrom: ["Vitruvio/Paineis", "Vitruvio/Processos"],
|
||||
occurrences: { total: 68, paineis: 68, processos: 0 }
|
||||
},
|
||||
sections: {
|
||||
purpose: "Componente para exibicao de informacoes, resultados e feedback visual.",
|
||||
basicUsage: "Usar WebPivotTableWidget no contexto adequado da tela; as propriedades abaixo foram observadas em exemplos reais do projeto.",
|
||||
properties: [
|
||||
"cssAlign",
|
||||
"height",
|
||||
"id",
|
||||
"version",
|
||||
"width"
|
||||
],
|
||||
propertyValues: {
|
||||
"cssAlign": ["top: 0px; left: 0px;"],
|
||||
"height": ["100%", "650px"],
|
||||
"id": ["pivotable"],
|
||||
"version": ["5"],
|
||||
"width": ["100%"]
|
||||
},
|
||||
propertyValueTypes: {
|
||||
"cssAlign": "mixed",
|
||||
"height": "numeric",
|
||||
"id": "enum",
|
||||
"version": "numeric",
|
||||
"width": "numeric"
|
||||
},
|
||||
events: [
|
||||
|
||||
],
|
||||
examples: [
|
||||
"Vitruvio/Paineis/Faturamento Meta (Cubo).xml:20",
|
||||
"Vitruvio/Paineis/Venda produto Unidade.xml:121",
|
||||
"Vitruvio/Paineis/Coleta de Produtos Críticos.xml:98",
|
||||
"Vitruvio/Paineis/GMD Desenv Vertical Principal.xml:24",
|
||||
"Vitruvio/Paineis/Análise de Movimentação de Produtos.xml:433",
|
||||
"Vitruvio/Paineis/Produtividade Analítica.xml:66",
|
||||
"Vitruvio/Paineis/DRE - Teste.xml:22",
|
||||
"Vitruvio/Paineis/Análise Importações Abertas - grid.xml:58",
|
||||
"Vitruvio/Paineis/Análise Energia - Cemig.xml:126",
|
||||
"Vitruvio/Paineis/Detalhes dos Débitos.xml:200",
|
||||
"Vitruvio/Paineis/Vendas.xml:28",
|
||||
"Vitruvio/Paineis/Perda Divergência Operacional Fornecedor.xml:73"
|
||||
],
|
||||
notes: [
|
||||
"Mapeamento automatico baseado em uso observado nos XMLs de paineis e processos.",
|
||||
"Valores ruidosos/textos muito longos sao filtrados para facilitar consulta.",
|
||||
"propertyValueTypes classifica o perfil observado da propriedade (boolean, enum, numeric, text ou mixed).",
|
||||
"Validar com documentacao oficial do Vitruvio quando houver divergencia funcional."
|
||||
]
|
||||
}
|
||||
};
|
||||
|
||||
export default WebPivotTableWidgetDoc;
|
||||
Reference in New Issue
Block a user