cmd
→
README
T
ChartSize
- ::newChartSize::new
- ::plot_areaChartSize::plot_area
T
ChartSummary
- ::from_pointsChartSummary::from_points
- ::to_jsonChartSummary::to_json
T
ChartTheme
- ::atelierChartTheme::atelier
- ::midnightChartTheme::midnight
T
DataPoint
- ::newDataPoint::new
T
PlotArea
T
ReportArtifact
T
SvgAudit
- ::passedSvgAudit::passed
V
audit_svg
V
escape_label
V
max_value
V
percent_of
V
render_accessible_report
V
render_bar_chart
V
render_dashboard
V
render_line_chart
V
render_metric_card
V
render_progress_bar
V
render_sparkline
V
total_value

moonchartkit

Accessible SVG and Markdown report artifacts for MoonBit.

report

svg

accessibility

markdown

moon add cosettese/moonchartkit@0.2.0

Download zip

Author

cosettese

Version

0.2.0

License

Apache-2.0

Repository

github.com/cosettese/moonchartkit

Last updated

last month

Downloads

README

#MoonChartKit

MoonChartKit 是面向 MoonBit 的无障碍 SVG 报告工件与文档可视化基础库。它服务于 README、CI 报告、Issue、PR、静态文档和小型状态面板，不试图替代完整统计绘图库。

#核心价值

多表示交付：一次生成 SVG、替代文本和 Markdown 数据表。
无障碍语义：SVG 包含 <title>、<desc>、role="img" 和 ARIA 关联。
结构化审计：自动检查可访问名称、描述、ARIA 与脚本风险。
安全嵌入：标题、描述、标签和主题文本统一转义。
后端中立：输出纯字符串，不依赖浏览器、DOM、Canvas 或文件系统。

#无障碍报告工件

test {
  let artifact = render_accessible_report(
    "Build Health",
    "CI status by target",
    [
      DataPoint::new("Native", 12),
      DataPoint::new("Wasm", 18),
    ],
    [10, 12, 15, 18],
  )

  assert_true(artifact.audit.passed())
  assert_true(artifact.svg.contains("aria-labelledby="))
  assert_true(artifact.markdown.contains("| Native |"))
}

ReportArtifact 包含：

svg：可直接嵌入 HTML 或文档的无障碍图形；
markdown：对屏幕阅读器、纯文本环境和代码评审友好的数据表；
alt_text：紧凑的自然语言摘要；
summary：结构化统计；
audit：可自动纳入 CI 的质量检查。

#其他组件

柱状图、折线图和 sparkline
Metric Card、Progress Bar
组合 Dashboard
Atelier 和 Midnight 主题
XML 转义与图表摘要 JSON

#运行与验收

moon check --target all
moon test --target wasm
moon run cmd/main
moon run cmd/bench

详见验收证据、相关工作和路线图。

#
ChartSize

source

pub(all) struct ChartSize {
  width : Int
  height : Int
  padding : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

#
ChartSize::new

source

fn ChartSize::new(width : Int, height : Int, padding : Int) -> ChartSize

#
ChartSize::plot_area

source

fn ChartSize::plot_area(self : ChartSize) -> PlotArea

#
ChartSummary

source

pub(all) struct ChartSummary {
  count : Int
  total : Int
  max : Int
  average : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

#
ChartSummary::from_points

source

fn ChartSummary::from_points(points : Array[DataPoint]) -> ChartSummary

#
ChartSummary::to_json

source

fn ChartSummary::to_json(self : ChartSummary) -> String

#
ChartTheme

source

pub(all) struct ChartTheme {
  background : String
  foreground : String
  accent : String
  accent_alt : String
  grid : String
  font_family : String
  radius : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

#
ChartTheme::atelier

source

fn ChartTheme::atelier() -> ChartTheme

#
ChartTheme::midnight

source

fn ChartTheme::midnight() -> ChartTheme

#
DataPoint

source

pub(all) struct DataPoint {
  label : String
  value : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

#
DataPoint::new

source

fn DataPoint::new(label : String, value : Int) -> DataPoint

#
PlotArea

source

pub(all) struct PlotArea {
  x : Int
  y : Int
  width : Int
  height : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

#
ReportArtifact

source

pub(all) struct ReportArtifact {
  svg : String
  markdown : String
  alt_text : String
  summary : ChartSummary
  audit : SvgAudit
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A report bundle with visual and non-visual representations.

#
SvgAudit

source

pub(all) struct SvgAudit {
  has_title : Bool
  has_description : Bool
  has_aria_labelledby : Bool
  has_role_img : Bool
  has_unsafe_script : Bool
  issue_count : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Structural accessibility and safety checks for generated SVG.

#
SvgAudit::passed

source

fn SvgAudit::passed(self : SvgAudit) -> Bool

#
audit_svg

source

fn audit_svg(svg : String) -> SvgAudit

Audits the accessibility contract used by MoonChartKit report artifacts.

#
escape_label

source

fn escape_label(value : String) -> String

#
max_value

source

fn max_value(points : Array[DataPoint]) -> Int

#
percent_of

source

fn percent_of(value : Int, total : Int) -> Int

#
render_accessible_report

source

fn render_accessible_report(title : String, description : String, points : Array[DataPoint], trend : Array[Int], size? : ChartSize, theme? : ChartTheme) -> ReportArtifact

Generates an accessible SVG report and a Markdown data fallback.

#
render_bar_chart

source

fn render_bar_chart(points : Array[DataPoint], title? : String, size? : ChartSize, theme? : ChartTheme) -> String

#
render_dashboard

source

fn render_dashboard(title : String, points : Array[DataPoint], trend : Array[Int], size? : ChartSize, theme? : ChartTheme) -> String

#
render_line_chart

source

fn render_line_chart(points : Array[DataPoint], title? : String, size? : ChartSize, theme? : ChartTheme) -> String

#
render_metric_card

source

fn render_metric_card(title : String, value : String, caption? : String, size? : ChartSize, theme? : ChartTheme) -> String

#
render_progress_bar

source

fn render_progress_bar(label : String, value : Int, max : Int, size? : ChartSize, theme? : ChartTheme) -> String

#
render_sparkline

source

fn render_sparkline(values : Array[Int], size? : ChartSize, theme? : ChartTheme) -> String

#
total_value

source

fn total_value(points : Array[DataPoint]) -> Int

Source Files

Site source Report issue Packages Build queue Skills Statistics

moonchartkit

#MoonChartKit

#核心价值

#无障碍报告工件

#其他组件

#运行与验收

#ChartSize

#ChartSize::new

#ChartSize::plot_area

#ChartSummary

#ChartSummary::from_points

#ChartSummary::to_json

#ChartTheme

#ChartTheme::atelier

#ChartTheme::midnight

#DataPoint

#DataPoint::new

#PlotArea

#ReportArtifact

#SvgAudit

#SvgAudit::passed

#audit_svg

#escape_label

#max_value

#percent_of

#render_accessible_report

#render_bar_chart

#render_dashboard

#render_line_chart

#render_metric_card

#render_progress_bar

#render_sparkline

#total_value

Source Files

#
ChartSize

#
ChartSize::new

#
ChartSize::plot_area

#
ChartSummary

#
ChartSummary::from_points

#
ChartSummary::to_json

#
ChartTheme

#
ChartTheme::atelier

#
ChartTheme::midnight

#
DataPoint

#
DataPoint::new

#
PlotArea

#
ReportArtifact

#
SvgAudit

#
SvgAudit::passed

#
audit_svg

#
escape_label

#
max_value

#
percent_of

#
render_accessible_report

#
render_bar_chart

#
render_dashboard

#
render_line_chart

#
render_metric_card

#
render_progress_bar

#
render_sparkline

#
total_value