API de componentes

Las props y los eventos de los dos componentes, tal como los declara @edubeam/plot 0.2.0. Ninguno tiene slots. Los valores en unidades SI se indican como tales; los tamaños son píxeles CSS.

StructurePlot

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

Dibuja una estructura plana y sus resultados. Guía: StructurePlot.

Props

PropTipoPor defectoDescripción
solverSolver–Un solver de @edubeam/fem. Los resultados se dibujan cuando su caso de carga está resuelto.
modelPlotModel–O los datos simples que genera modelFromSolver. Tiene prioridad sobre solver.
loadCasenumber0Índice en solver.loadCases
revisionnumber0Cámbiala para volver a dibujar un solver modificado directamente
layersreadonly PlotLayer[]barras, apoyos, cargas, reacciones y un resultadoQué dibujar: 'nodes', 'nodeLabels', 'dimensions', 'members', 'supports', 'loads', 'reactions', 'N', 'V', 'M', 'w'
reservereadonly PlotLayer[]layersCapas para las que se reserva espacio mientras están ocultas
compactbooleanfalseDibujo en miniatura: símbolos más pequeños, como mucho dos valores por barra
unitsPartial<Units>KN_UNITSUnidades de visualización
numberFormatIntl.NumberFormatinglés, como mucho 1 decimalDa formato a todos los números
colorsPartial<PlotColors>–Colores propios por tono: Temas y colores
widthnumber640; con compact, 400Ancho antes de medir el contenedor, como en el servidor
heightnumber–Altura fija. Sin ella, la altura se adapta al dibujo.
maxHeightnumbermax(320, 0.75 × width); con compact, sin límiteLímite superior de la altura automática
paddingnumber6Margen alrededor del dibujo
fontSizenumber13; con compact, 11.5Tamaño del texto
diagramSizenumber48; con compact, 26Longitud de la mayor ordenada de un diagrama
deformedSizenumber30; con compact, 18Mayor desplazamiento en la deformada
diagramScalePartial<Record<ResultLayer, number>>–Escala fija en px por unidad SI para un resultado; sustituye a diagramSize o deformedSize
momentOnTensionSidebooleantrueM en el lado traccionado; false para el lado comprimido
resultLabelMode'horizontal' | 'axis''horizontal'Valores en horizontal, o girados en la dirección de su ordenada
reactionLabels'values' | 'names''values'Reacciones tal como actúan, con su valor; o, para un ejercicio, cada dirección impedida con su nombre (Ax, MA) y apuntando en el sentido que se toma como positivo. Los nombres no necesitan resultados: Reacciones como incógnitas
reserveLabelModesreadonly ResultLabelMode[]–Modos de etiqueta para los que se reserva espacio además del actual
reserveReactionLabelsreadonly ReactionLabels[]–Estilos de etiqueta de las reacciones para los que se reserva espacio además de reactionLabels, para que el dibujo de un ejercicio no se mueva cuando se convierte en su solución
animatebooleantrueLas capas aparecen con un fundido y las barras se dibujan. Siempre desactivado con prefers-reduced-motion.
hoverbooleanfalseLee los valores bajo el puntero y los marca en el extremo de la ordenada de cada diagrama. Desactivado, el gráfico no recibe ninguna entrada del puntero.
titlestringuna descripción de lo que se muestraNombre accesible de la figura

Sin layers, el resultado es M para vigas y pórticos, N para una celosía y w cuando ninguna barra transmite esfuerzos (defaultResultLayer).

Eventos

EventoDatosCuándo
readoutReadout | nullCon hover: el punto de la barra bajo el puntero y sus resultados; null cuando el puntero sale
TypeScript
interface Readout {
  readonly member: string
  readonly x: number // m desde el nodo inicial de la barra
  readonly px: number // el punto en pantalla, px
  readonly py: number
  readonly values: Readonly<Record<'N' | 'V' | 'M' | 'w', SidedValue>> // unidades SI
  readonly u: number // desplazamiento según el eje x local de la barra, m
}
interface SidedValue {
  readonly left: number
  readonly right: number // igual a left donde el resultado es continuo
}

DiagramStack

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

Dibuja una viga recta sobre sus diagramas en un mismo eje x. Las barras deben formar una sola línea horizontal, dibujada de izquierda a derecha; cualquier otra cosa lanza un error. Guía: DiagramStack.

Props

PropTipoPor defectoDescripción
solverSolver–La viga resuelta
modelPlotModel–O los datos simples de modelFromSolver; tiene prioridad
loadCasenumber0Índice en solver.loadCases
revisionnumber0Cámbiala para volver a dibujar un solver modificado directamente
membersreadonly string[]todas las barrasLas barras de la línea de la viga
rowsreadonly StackRow[]['V', 'M', 'w']Filas de diagramas, de arriba abajo, entre 'N', 'V', 'M', 'w'
loadRowbooleantrueLa viga con sus apoyos, cargas y reacciones encima de las filas
rangesPartial<Record<StackRow, readonly [number, number]>>el propio de cada filaRango de valores de cada fila, unidades SI
rowHeightsPartial<Record<StackRow, number>>N 100, V 116, M 128, w 76; por debajo de 560 px de ancho 88, 96, 104, 64Altura de las filas antes de que maxHeight las escale
maxHeightnumber–Las filas se reducen, como mucho al 60 %, para que la figura quepa. El texto conserva su tamaño.
unitsPartial<Units>KN_UNITSUnidades de visualización
numberFormatIntl.NumberFormatinglés, como mucho 1 decimalDa formato a todos los números
colorsPartial<PlotColors>–Colores propios
widthnumber720Ancho antes de medir el contenedor; se usa como mínimo 320
fontSizenumber12.5Tamaño del texto
hoverbooleantrueEl cursor de lectura. Desactivado, la figura no recibe ninguna entrada del puntero.
loadAtnumber–Posición (m a lo largo de la línea) de una carga puntual que el lector puede arrastrar; se usa con v-model:load-at
loadLabelstringP = … con el valor de la cargaTexto junto a la carga que se arrastra
loadStepnumber0.05Paso en m al que se redondea el arrastre; las flechas del teclado mueven la carga en ese paso
titlestringuna descripción de las filasNombre accesible de la figura

Eventos

EventoDatosCuándo
update:loadAtnumberEl lector ha movido la carga: su nueva posición, en m. Alimenta v-model:load-at.
readoutStackReadout | nullLos valores del cursor en todas las filas; null cuando el puntero sale
TypeScript
interface StackReadout {
  readonly x: number // m a lo largo de la línea de la viga
  readonly values: Partial<Record<'N' | 'V' | 'M' | 'w', { readonly left: number; readonly right: number }>> // SI
}

El plugin

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

app.use(EduBeamPlot) // registra <StructurePlot> y <DiagramStack> globalmente

Es opcional: importar los componentes por su nombre resulta más ligero, y un bundler elimina el plugin de un build que no lo usa.

Tipos

Para envolver los componentes con tipos, el paquete exporta sus props y sus eventos:

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

const figure: StructurePlotProps = { layers: ['members', 'supports', 'M'] satisfies PlotLayer[], compact: true }
TipoContiene
StructurePlotProps, StructurePlotEmitsLas props y los eventos de StructurePlot
DiagramStackProps, DiagramStackEmitsLas props y los eventos de DiagramStack
Readout, ReadoutQuantity, SidedValue, StackReadoutLos datos de los eventos
PlotLayer, ResultLayer, ResultLabelMode, ReactionLabels, StackRowLos nombres de capas, resultados, modos de etiqueta, estilos de etiqueta de las reacciones y filas
Units, Unit, UnitKindUnidades de visualización: { symbol, scale } para cada magnitud
PlotColorsColores por tono
PlotModelEl modelo de datos simple: Modelo de dibujo

Las demás exportaciones, entre ellas structureSvg para archivos SVG y las funciones que hay detrás del dibujo, están en Funciones.