API компонентов

Свойства (props) и события обоих компонентов в том виде, как они объявлены в @edubeam/plot 0.2.0. Слотов нет ни у одного из них. Значения в единицах СИ отмечены особо; размеры указаны в CSS-пикселях.

StructurePlot

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

Рисует плоскую конструкцию и результаты её расчёта. Подробнее: StructurePlot.

Свойства

СвойствоТипПо умолчаниюОписание
solverSolver–Решатель @edubeam/fem. Результаты рисуются, как только его случай нагружения рассчитан.
modelPlotModel–Или простые данные, которые создаёт modelFromSolver. Имеет приоритет над solver.
loadCasenumber0Индекс в solver.loadCases
revisionnumber0Измените, чтобы перерисовать решатель, изменённый на месте
layersreadonly PlotLayer[]стержни, опоры, нагрузки, реакции и один результатЧто рисовать: 'nodes', 'nodeLabels', 'dimensions', 'members', 'supports', 'loads', 'reactions', 'N', 'V', 'M', 'w'
reservereadonly PlotLayer[]layersСлои, для которых нужно оставить место, пока они скрыты
compactbooleanfalseРисунок для миниатюр: меньшие обозначения, не больше двух значений на стержень
unitsPartial<Units>KN_UNITSЕдиницы отображения
numberFormatIntl.NumberFormatанглийский, не больше 1 знака после запятойФорматирует все числа
colorsPartial<PlotColors>–Замена цветов по тонам: Темы и цвета
widthnumber640, compact 400Ширина до измерения контейнера, например на сервере
heightnumber–Фиксированная высота. Без неё высота подстраивается под изображение.
maxHeightnumbermax(320, 0.75 × width), compact нетВерхняя граница автоматической высоты
paddingnumber6Отступ вокруг изображения
fontSizenumber13, compact 11.5Размер текста
diagramSizenumber48, compact 26Длина наибольшей ординаты эпюры
deformedSizenumber30, compact 18Наибольшее перемещение на деформированной схеме
diagramScalePartial<Record<ResultLayer, number>>–Фиксированный масштаб результата в px на единицу СИ; заменяет diagramSize или deformedSize
momentOnTensionSidebooleantrueM со стороны растянутых волокон; false — со стороны сжатых
resultLabelMode'horizontal' | 'axis''horizontal'Значения стоят прямо или повёрнуты вдоль своей ординаты
reactionLabels'values' | 'names''values'Реакции в том направлении, в котором действуют, с величиной; или, для упражнения, каждое закреплённое направление с обозначением (Ax, MA) и стрелкой в положительную сторону. Для обозначений результаты не нужны: Реакции как неизвестные
reserveLabelModesreadonly ResultLabelMode[]–Режимы подписей, для которых нужно оставить место помимо текущего
reserveReactionLabelsreadonly ReactionLabels[]–Стили подписей реакций, для которых нужно оставить место помимо reactionLabels, чтобы рисунок не сдвигался, когда упражнение превращается в решение
animatebooleantrueПлавное появление слоёв и прорисовка стержней. При prefers-reduced-motion всегда выключено.
hoverbooleanfalseСчитывание значений под указателем с отметками на концах ординат эпюр. Если выключено, рисунок вообще не принимает ввод указателем.
titlestringописание показанногоДоступное имя рисунка

Без layers показывается результат M для балок и рам, N для фермы и w, если усилий нет нигде (defaultResultLayer).

События

СобытиеДанныеКогда
readoutReadout | nullС hover: точка стержня под указателем и результаты в ней; null, когда указатель уходит
TypeScript
interface Readout {
  readonly member: string
  readonly x: number // м от начального узла стержня
  readonly px: number // точка на экране, px
  readonly py: number
  readonly values: Readonly<Record<'N' | 'V' | 'M' | 'w', SidedValue>> // единицы СИ
  readonly u: number // перемещение вдоль локальной оси x стержня, м
}
interface SidedValue {
  readonly left: number
  readonly right: number // равно left там, где результат непрерывен
}

DiagramStack

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

Рисует прямую балку над её эпюрами на общей оси x. Стержни должны образовывать одну горизонтальную линию, заданную слева направо; в остальных случаях выбрасывается исключение. Подробнее: DiagramStack.

Свойства

СвойствоТипПо умолчаниюОписание
solverSolver–Рассчитанная балка
modelPlotModel–Или простые данные из modelFromSolver; имеет приоритет
loadCasenumber0Индекс в solver.loadCases
revisionnumber0Измените, чтобы перерисовать решатель, изменённый на месте
membersreadonly string[]все стержниСтержни балочной линии
rowsreadonly StackRow[]['V', 'M', 'w']Ряды эпюр сверху вниз, из 'N', 'V', 'M', 'w'
loadRowbooleantrueБалка с опорами, нагрузками и реакциями над рядами
rangesPartial<Record<StackRow, readonly [number, number]>>у каждого ряда свойДиапазон значений для ряда, единицы СИ
rowHeightsPartial<Record<StackRow, number>>N 100, V 116, M 128, w 76; при ширине меньше 560 px — 88, 96, 104, 64Высоты рядов до масштабирования по maxHeight
maxHeightnumber–Чтобы рисунок поместился, ряды сжимаются, но не ниже 60 % своей высоты. Размер текста не меняется.
unitsPartial<Units>KN_UNITSЕдиницы отображения
numberFormatIntl.NumberFormatанглийский, не больше 1 знака после запятойФорматирует все числа
colorsPartial<PlotColors>–Замена цветов
widthnumber720Ширина до измерения контейнера; используется не меньше 320
fontSizenumber12.5Размер текста
hoverbooleantrueКурсор для считывания. Если выключен, рисунок не принимает ввод указателем.
loadAtnumber–Положение (м вдоль линии) сосредоточенной силы, которую может перетаскивать читатель; используется с v-model:load-at
loadLabelstringP = … с величиной силыТекст рядом с перетаскиваемой силой
loadStepnumber0.05Шаг округления при перетаскивании, м; на этот шаг сдвигают клавиши со стрелками
titlestringописание рядовДоступное имя рисунка

События

СобытиеДанныеКогда
update:loadAtnumberЧитатель сдвинул силу: её новое положение, м. На этом событии работает v-model:load-at.
readoutStackReadout | nullЗначения курсора во всех рядах; null, когда указатель уходит
TypeScript
interface StackReadout {
  readonly x: number // м вдоль балочной линии
  readonly values: Partial<Record<'N' | 'V' | 'M' | 'w', { readonly left: number; readonly right: number }>> // СИ
}

Плагин

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

app.use(EduBeamPlot) // регистрирует <StructurePlot> и <DiagramStack> глобально

Плагин не обязателен: импорт компонентов по имени легче, а сборщик выбрасывает плагин из сборки, которая его не использует.

Типы

Для типизированных обёрток вокруг компонентов пакет экспортирует типы их свойств и событий:

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

const figure: StructurePlotProps = { layers: ['members', 'supports', 'M'] satisfies PlotLayer[], compact: true }
ТипЧто это
StructurePlotProps, StructurePlotEmitsСвойства и события StructurePlot
DiagramStackProps, DiagramStackEmitsСвойства и события DiagramStack
Readout, ReadoutQuantity, SidedValue, StackReadoutДанные событий
PlotLayer, ResultLayer, ResultLabelMode, ReactionLabels, StackRowНазвания слоёв, результатов, режимов подписей, подписей реакций и рядов
Units, Unit, UnitKindЕдиницы отображения: { symbol, scale } для каждого вида
PlotColorsЦвета по тонам
PlotModelПростая модель: Модель рисунка

Остальные экспорты, в том числе structureSvg для SVG-файлов и функции, на которых построено рисование, описаны на странице Функции.