API dos componentes

As props e os eventos dos dois componentes, como declarados no @edubeam/plot 0.2.0. Nenhum dos dois tem slots. Os valores em unidades SI estão indicados como tal; os tamanhos são pixels CSS.

StructurePlot

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

Desenha uma estrutura plana e os seus resultados. Guia: StructurePlot.

Props

PropTipoPadrãoDescrição
solverSolver–Um solver do @edubeam/fem. Os resultados são desenhados quando o seu caso de carga está resolvido.
modelPlotModel–Ou os dados simples gerados por modelFromSolver. Tem prioridade sobre solver.
loadCasenumber0Índice em solver.loadCases
revisionnumber0Altere-o para redesenhar um solver modificado diretamente
layersreadonly PlotLayer[]barras, apoios, cargas, reações e um resultadoO que desenhar: 'nodes', 'nodeLabels', 'dimensions', 'members', 'supports', 'loads', 'reactions', 'N', 'V', 'M', 'w'
reservereadonly PlotLayer[]layersCamadas para as quais se reserva espaço enquanto estão ocultas
compactbooleanfalseDesenho de miniatura: símbolos menores, no máximo dois valores por barra
unitsPartial<Units>KN_UNITSUnidades de exibição
numberFormatIntl.NumberFormatinglês, no máximo 1 casa decimalFormata todos os números
colorsPartial<PlotColors>–Substitui cores, por tom: Temas e cores
widthnumber640, compact 400Largura antes de o contêiner ser medido, como no servidor
heightnumber–Altura fixa. Sem ela, a altura acompanha o desenho.
maxHeightnumbermax(320, 0.75 × width), compact: nenhumLimite superior da altura automática
paddingnumber6Espaço em volta do desenho
fontSizenumber13, compact 11.5Tamanho do texto
diagramSizenumber48, compact 26Comprimento da maior ordenada dos diagramas
deformedSizenumber30, compact 18Maior deslocamento na deformada
diagramScalePartial<Record<ResultLayer, number>>–Escala fixa em px por unidade SI para um resultado; substitui diagramSize ou deformedSize
momentOnTensionSidebooleantrueM do lado tracionado; false para o lado comprimido
resultLabelMode'horizontal' | 'axis''horizontal'Valores na horizontal ou girados ao longo da ordenada
reactionLabels'values' | 'names''values'As reações como atuam, com a sua intensidade; ou, para um exercício, cada direção restringida com um nome (Ax, MA), apontando no sentido em que é considerada positiva. Os nomes não precisam de resultados: Reações como incógnitas
reserveLabelModesreadonly ResultLabelMode[]–Modos de rótulo para os quais se reserva espaço além do atual
reserveReactionLabelsreadonly ReactionLabels[]–Estilos de rótulo das reações para os quais se reserva espaço além de reactionLabels, para que um exercício que se transforma na sua solução mantenha o desenho parado
animatebooleantrueFaz as camadas surgirem gradualmente e as barras se desenharem. Sempre desligado com prefers-reduced-motion.
hoverbooleanfalseLê os valores sob o ponteiro, marcados na extremidade da ordenada de cada diagrama. Quando desligado, a figura não recebe nenhuma entrada do ponteiro.
titlestringuma descrição do que é mostradoNome acessível da figura

Sem layers, o resultado é M para vigas e pórticos, N para uma treliça e w quando nada transmite esforço (defaultResultLayer).

Eventos

EventoPayloadQuando
readoutReadout | nullCom hover: o ponto da barra sob o ponteiro e os seus resultados; null quando o ponteiro sai
TypeScript
interface Readout {
  readonly member: string
  readonly x: number // m a partir do nó inicial da barra
  readonly px: number // o ponto na tela, px
  readonly py: number
  readonly values: Readonly<Record<'N' | 'V' | 'M' | 'w', SidedValue>> // unidades SI
  readonly u: number // deslocamento ao longo do x local da barra, m
}
interface SidedValue {
  readonly left: number
  readonly right: number // igual a left onde o resultado é contínuo
}

DiagramStack

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

Desenha uma viga reta sobre os seus diagramas num mesmo eixo x. As barras devem formar uma única linha horizontal, desenhada da esquerda para a direita; qualquer outra coisa lança um erro. Guia: DiagramStack.

Props

PropTipoPadrãoDescrição
solverSolver–A viga resolvida
modelPlotModel–Ou os dados simples de modelFromSolver; tem prioridade
loadCasenumber0Índice em solver.loadCases
revisionnumber0Altere-o para redesenhar um solver modificado diretamente
membersreadonly string[]todas as barrasAs barras da linha da viga
rowsreadonly StackRow[]['V', 'M', 'w']As linhas de diagramas, de cima para baixo, entre 'N', 'V', 'M', 'w'
loadRowbooleantrueA viga com os seus apoios, cargas e reações acima das linhas
rangesPartial<Record<StackRow, readonly [number, number]>>o de cada linhaIntervalo de valores por linha, em unidades SI
rowHeightsPartial<Record<StackRow, number>>N 100, V 116, M 128, w 76; abaixo de 560 px de largura, 88, 96, 104, 64Alturas das linhas antes de maxHeight reduzi-las
maxHeightnumber–As linhas encolhem, até 60 % no máximo, para que a figura caiba. O texto mantém o tamanho.
unitsPartial<Units>KN_UNITSUnidades de exibição
numberFormatIntl.NumberFormatinglês, no máximo 1 casa decimalFormata todos os números
colorsPartial<PlotColors>–Substitui cores
widthnumber720Largura antes de o contêiner ser medido; usa-se no mínimo 320
fontSizenumber12.5Tamanho do texto
hoverbooleantrueO cursor de leitura. Quando desligado, a figura não recebe nenhuma entrada do ponteiro.
loadAtnumber–Posição (em m ao longo da linha) de uma carga concentrada que o leitor pode arrastar; use com v-model:load-at
loadLabelstringP = … com a intensidade da cargaTexto ao lado da carga arrastável
loadStepnumber0.05O arrasto é arredondado a esse passo, em m; as setas do teclado movem a carga por ele
titlestringuma descrição das linhasNome acessível da figura

Eventos

EventoPayloadQuando
update:loadAtnumberO leitor moveu a carga: a nova posição, em m. Alimenta v-model:load-at.
readoutStackReadout | nullOs valores do cursor em todas as linhas; null quando o ponteiro sai
TypeScript
interface StackReadout {
  readonly x: number // m ao longo da linha da viga
  readonly values: Partial<Record<'N' | 'V' | 'M' | 'w', { readonly left: number; readonly right: number }>> // SI
}

O plugin

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

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

Ele é opcional: importar os componentes pelo nome é mais leve, e um bundler descarta o plugin de um build que não o usa.

Tipos

Para wrappers tipados em volta dos componentes, o pacote exporta as suas props e os seus eventos:

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

const figure: StructurePlotProps = { layers: ['members', 'supports', 'M'] satisfies PlotLayer[], compact: true }
TipoO que é
StructurePlotProps, StructurePlotEmitsAs props e os eventos de StructurePlot
DiagramStackProps, DiagramStackEmitsAs props e os eventos de DiagramStack
Readout, ReadoutQuantity, SidedValue, StackReadoutPayloads dos eventos
PlotLayer, ResultLayer, ResultLabelMode, ReactionLabels, StackRowNomes de camadas, resultados, modos de rótulo, rótulos de reação e linhas
Units, Unit, UnitKindUnidades de exibição: { symbol, scale } por tipo
PlotColorsCores por tom
PlotModelO modelo de dados simples: Modelo de desenho

As demais exportações, entre elas structureSvg para arquivos SVG e as funções por trás do desenho, estão em Funções.