API des composants

Les props et les événements des deux composants, tels que déclarés dans @edubeam/plot 0.2.0. Aucun des deux n’a de slot. Les valeurs en unités SI sont signalées comme telles ; les tailles sont en pixels CSS.

StructurePlot

TypeScript
import { StructurePlot } from '@edubeam/plot'

Dessine une structure plane et ses résultats. Guide : StructurePlot.

Props

PropTypeDéfautDescription
solverSolver–Un solveur @edubeam/fem. Les résultats sont dessinés dès que son cas de charge est calculé.
modelPlotModel–Ou les données simples que produit modelFromSolver. Prioritaire sur solver.
loadCasenumber0Indice dans solver.loadCases
revisionnumber0À modifier pour redessiner un solveur modifié sur place
layersreadonly PlotLayer[]barres, appuis, charges, réactions et un résultatCe qu’il faut dessiner : 'nodes', 'nodeLabels', 'dimensions', 'members', 'supports', 'loads', 'reactions', 'N', 'V', 'M', 'w'
reservereadonly PlotLayer[]layersCouches dont la place est réservée tant qu’elles sont masquées
compactbooleanfalseDessin de miniature : symboles plus petits, au plus deux valeurs par barre
unitsPartial<Units>KN_UNITSUnités d’affichage
numberFormatIntl.NumberFormatanglais, au plus 1 décimaleFormate tous les nombres
colorsPartial<PlotColors>–Couleurs remplacées, par teinte : Thèmes et couleurs
widthnumber640, compact 400Largeur avant la mesure du conteneur, par exemple côté serveur
heightnumber–Hauteur fixe. Sans elle, la hauteur suit le dessin.
maxHeightnumbermax(320, 0.75 × width), compact aucuneLimite supérieure de la hauteur automatique
paddingnumber6Espace autour du dessin
fontSizenumber13, compact 11.5Taille du texte
diagramSizenumber48, compact 26Longueur de la plus grande ordonnée d’un diagramme
deformedSizenumber30, compact 18Plus grand déplacement de la déformée
diagramScalePartial<Record<ResultLayer, number>>–Échelle fixe en px par unité SI pour un résultat, à la place de diagramSize ou deformedSize
momentOnTensionSidebooleantrueM du côté tendu ; false pour le côté comprimé
resultLabelMode'horizontal' | 'axis''horizontal'Valeurs horizontales, ou orientées le long de leur ordonnée
reactionLabels'values' | 'names''values'Les réactions telles qu’elles agissent, avec leur valeur ; ou, pour un exercice, chaque direction bloquée nommée (Ax, MA) et orientée dans le sens compté comme positif. Les noms n’ont pas besoin de résultats : Réactions inconnues
reserveLabelModesreadonly ResultLabelMode[]–Modes d’étiquetage dont la place est réservée en plus du mode courant
reserveReactionLabelsreadonly ReactionLabels[]–Styles d’étiquettes de réaction dont la place est réservée en plus de reactionLabels, pour qu’un exercice qui devient son corrigé garde un dessin immobile
animatebooleantrueFait apparaître les couches en fondu et trace les barres. Toujours désactivé avec prefers-reduced-motion.
hoverbooleanfalseLit les valeurs sous le pointeur, marquées à l’extrémité de l’ordonnée de chaque diagramme. Désactivé, la figure ne réagit à aucune entrée du pointeur.
titlestringune description de ce qui est affichéNom accessible de la figure

Sans layers, le résultat est M pour les poutres et les portiques, N pour un treillis, et w lorsqu’aucune barre n’est sollicitée (defaultResultLayer).

Événements

ÉvénementDonnéesQuand
readoutReadout | nullAvec hover : le point de la barre sous le pointeur et ses résultats ; null quand le pointeur quitte la figure
TypeScript
interface Readout {
  readonly member: string
  readonly x: number // m depuis le nœud initial de la barre
  readonly px: number // le point à l’écran, px
  readonly py: number
  readonly values: Readonly<Record<'N' | 'V' | 'M' | 'w', SidedValue>> // unités SI
  readonly u: number // déplacement selon l’axe x local de la barre, m
}
interface SidedValue {
  readonly left: number
  readonly right: number // égal à left là où le résultat est continu
}

DiagramStack

TypeScript
import { DiagramStack } from '@edubeam/plot'

Dessine une poutre droite au-dessus de ses diagrammes, sur un même axe x. Les barres doivent former une seule ligne horizontale, dessinée de gauche à droite ; dans tout autre cas, le composant lève une exception. Guide : DiagramStack.

Props

PropTypeDéfautDescription
solverSolver–La poutre calculée
modelPlotModel–Ou les données simples de modelFromSolver ; prioritaire
loadCasenumber0Indice dans solver.loadCases
revisionnumber0À modifier pour redessiner un solveur modifié sur place
membersreadonly string[]toutes les barresLes barres de la ligne de poutre
rowsreadonly StackRow[]['V', 'M', 'w']Lignes de diagrammes, de haut en bas, parmi 'N', 'V', 'M', 'w'
loadRowbooleantrueLa poutre avec ses appuis, ses charges et ses réactions au-dessus des lignes
rangesPartial<Record<StackRow, readonly [number, number]>>celle de chaque lignePlage de valeurs par ligne, unités SI
rowHeightsPartial<Record<StackRow, number>>N 100, V 116, M 128, w 76 ; sous 560 px de largeur 88, 96, 104, 64Hauteurs des lignes avant leur mise à l’échelle par maxHeight
maxHeightnumber–Les lignes rétrécissent, jusqu’à 60 % au plus, pour que la figure tienne. Le texte garde sa taille.
unitsPartial<Units>KN_UNITSUnités d’affichage
numberFormatIntl.NumberFormatanglais, au plus 1 décimaleFormate tous les nombres
colorsPartial<PlotColors>–Couleurs remplacées
widthnumber720Largeur avant la mesure du conteneur ; la largeur utilisée vaut au moins 320
fontSizenumber12.5Taille du texte
hoverbooleantrueLe curseur de lecture. Désactivé, la figure ne réagit à aucune entrée du pointeur.
loadAtnumber–Position (m le long de la ligne) d’une charge ponctuelle que le lecteur peut faire glisser ; à utiliser avec v-model:load-at
loadLabelstringP = … avec l’intensité de la chargeTexte à côté de la charge déplaçable
loadStepnumber0.05Pas auquel le glissement est arrondi, m ; les touches fléchées déplacent la charge de ce pas
titlestringune description des lignesNom accessible de la figure

Événements

ÉvénementDonnéesQuand
update:loadAtnumberLe lecteur a déplacé la charge : sa nouvelle position, m. Pilote v-model:load-at.
readoutStackReadout | nullLes valeurs du curseur sur toutes les lignes ; null quand le pointeur quitte la figure
TypeScript
interface StackReadout {
  readonly x: number // m le long de la ligne de poutre
  readonly values: Partial<Record<'N' | 'V' | 'M' | 'w', { readonly left: number; readonly right: number }>> // SI
}

Le plugin

TypeScript
import { EduBeamPlot } from '@edubeam/plot'

app.use(EduBeamPlot) // enregistre <StructurePlot> et <DiagramStack> globalement

Il est facultatif : importer les composants par leur nom est plus léger, et un bundler retire le plugin d’un build qui ne l’utilise pas.

Types

Pour écrire des wrappers typés autour des composants, le paquet exporte leurs props et leurs événements :

TypeScript
import type { PlotLayer, StructurePlotProps } from '@edubeam/plot'

const figure: StructurePlotProps = { layers: ['members', 'supports', 'M'] satisfies PlotLayer[], compact: true }
TypeReprésente
StructurePlotProps, StructurePlotEmitsLes props et les événements de StructurePlot
DiagramStackProps, DiagramStackEmitsLes props et les événements de DiagramStack
Readout, ReadoutQuantity, SidedValue, StackReadoutLes données des événements
PlotLayer, ResultLayer, ResultLabelMode, ReactionLabels, StackRowLes noms des couches, des résultats, des modes d’étiquetage, des étiquettes de réaction et des lignes
Units, Unit, UnitKindUnités d’affichage : { symbol, scale } par grandeur
PlotColorsCouleurs par teinte
PlotModelLe modèle simple : Modèle de dessin

Les autres exports, dont structureSvg pour les fichiers SVG et les fonctions qui produisent le dessin, sont décrits dans Fonctions.