コンポーネント API

@edubeam/plot 0.2.0 で宣言されている、2 つのコンポーネントのプロパティとイベントです。どちらにもスロットはありません。SI 単位の値はその旨を記しています。サイズは CSS ピクセルです。

StructurePlot

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

平面の構造物とその結果を描きます。使い方は StructurePlot のページで説明しています。

プロパティ

プロパティ型既定値説明
solverSolver–@edubeam/fem のソルバー。荷重ケースが解かれていれば結果も描く。
modelPlotModel–または modelFromSolver が作るプレーンなデータ。solver より優先される。
loadCasenumber0solver.loadCases のインデックス
revisionnumber0その場で変更したソルバーを再描画するとき、この値を変える
layersreadonly PlotLayer[]members, supports, loads, reactions and one result描くもの:'nodes'、'nodeLabels'、'dimensions'、'members'、'supports'、'loads'、'reactions'、'N'、'V'、'M'、'w'
reservereadonly PlotLayer[]layers非表示の間も場所を確保するレイヤー
compactbooleanfalseサムネイル用の描き方:小さな記号、値は 1 部材あたり最大 2 つ
unitsPartial<Units>KN_UNITS表示単位
numberFormatIntl.NumberFormatEnglish, at most 1 decimalすべての数値の書式
colorsPartial<PlotColors>–トーンごとの色の上書き:テーマと色
widthnumber640, compact 400枠を測るまでの幅(サーバー上など)
heightnumber–固定の高さ。指定しないと、高さは図の内容に合わせて決まる。
maxHeightnumbermax(320, 0.75 × width), compact none自動で決まる高さの上限
paddingnumber6図の周囲の余白
fontSizenumber13, compact 11.5文字サイズ
diagramSizenumber48, compact 26断面力図の最大の縦距の長さ
deformedSizenumber30, compact 18変位図の最大変位
diagramScalePartial<Record<ResultLayer, number>>–結果ごとに SI 単位あたりの 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ポインターの下の値を読み取り、各断面力図の縦距の先端に印を付ける。オフのとき、図はポインター入力を一切受け取らない。
titlestringa description of what is shown図のアクセシブルな名前

layers を指定しない場合、結果は梁とラーメンでは M、トラスでは N、どの部材にも力が生じない場合は w です(defaultResultLayer)。

イベント

イベントペイロード発行されるとき
readoutReadout | nullhover 指定時:ポインターの下にある部材上の点とその結果。ポインターが離れると null
TypeScript
interface Readout {
  readonly member: string
  readonly x: number // 部材の始端節点からの距離、m
  readonly px: number // 画面上の点、px
  readonly py: number
  readonly values: Readonly<Record<'N' | 'V' | 'M' | 'w', SidedValue>> // SI 単位
  readonly u: number // 部材のローカル x 方向の変位、m
}
interface SidedValue {
  readonly left: number
  readonly right: number // 結果が連続な位置では left と等しい
}

DiagramStack

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

真っすぐな梁とその断面力図を、共通の x 軸で描きます。部材は左から右へ描いた 1 本の水平な直線になっていなければならず、それ以外ではエラーを投げます。使い方は DiagramStack のページで説明しています。

プロパティ

プロパティ型既定値説明
solverSolver–解析済みの梁
modelPlotModel–または modelFromSolver によるプレーンなデータ。こちらが優先される
loadCasenumber0solver.loadCases のインデックス
revisionnumber0その場で変更したソルバーを再描画するとき、この値を変える
membersreadonly string[]all members梁の線を構成する部材
rowsreadonly StackRow[]['V', 'M', 'w']図の段(上から順)。'N'、'V'、'M'、'w' から選ぶ
loadRowbooleantrue各段の上に、支点、荷重、反力の付いた梁を描く
rangesPartial<Record<StackRow, readonly [number, number]>>each row's own段ごとの値の範囲、SI 単位
rowHeightsPartial<Record<StackRow, number>>N 100, V 116, M 128, w 76; below 560 px wide 88, 96, 104, 64maxHeight で縮める前の各段の高さ
maxHeightnumber–図が収まるよう各段を縮める(最小 60 %)。文字サイズは変わらない。
unitsPartial<Units>KN_UNITS表示単位
numberFormatIntl.NumberFormatEnglish, at most 1 decimalすべての数値の書式
colorsPartial<PlotColors>–色の上書き
widthnumber720枠を測るまでの幅。320 未満にはならない
fontSizenumber12.5文字サイズ
hoverbooleantrue読み取りカーソル。オフのとき、図はポインター入力を受け取らない。
loadAtnumber–読者がドラッグできる集中荷重の位置(梁の線に沿った m)。v-model:load-at と併用
loadLabelstringP = … with the load's magnitudeドラッグできる荷重の横に表示する文字
loadStepnumber0.05ドラッグ時に丸める刻み、m。矢印キーでの移動量もこの値
titlestringa description of the rows図のアクセシブルな名前

イベント

イベントペイロード発行されるとき
update:loadAtnumber読者が荷重を動かしたとき:新しい位置、m。v-model:load-at はこのイベントで動く
readoutStackReadout | null各段のカーソル位置の値。ポインターが離れると null
TypeScript
interface StackReadout {
  readonly x: number // 梁の線に沿った位置、m
  readonly values: Partial<Record<'N' | 'V' | 'M' | 'w', { readonly left: number; readonly right: number }>> // SI
}

プラグイン

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, StructurePlotEmitsStructurePlot のプロパティとイベント
DiagramStackProps, DiagramStackEmitsDiagramStack のプロパティとイベント
Readout, ReadoutQuantity, SidedValue, StackReadoutイベントのペイロード
PlotLayer, ResultLayer, ResultLabelMode, ReactionLabels, StackRowレイヤー、結果、ラベルモード、反力ラベル、段の名前
Units, Unit, UnitKind表示単位:種類ごとの { symbol, scale }
PlotColorsトーンごとの色
PlotModelプレーンなモデル:描画モデル

残りのエクスポート(SVG ファイル用の structureSvg や、描画を支える関数など)は関数のページにあります。