Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃摉 API Docs #48

Closed
leeoniya opened this issue Nov 5, 2019 · 3 comments
Closed

馃摉 API Docs #48

leeoniya opened this issue Nov 5, 2019 · 3 comments
Labels
docs Improvements or additions to documentation
Milestone

Comments

@leeoniya
Copy link
Owner

leeoniya commented Nov 5, 2019

  • data format & requirements
  • how scales, axes and series interact
  • DOM structure: classes of axes, labels, cursors, points, plot, grid, chart
  • mouse interaction: zoom/unzoom, focus-hover (plot & legend), cursor lock/unlock, legend series toggle
  • series.value can be a template string if time: true
  • passing then to constructor to fire init after custom dom injection

declarative opts:

  • .data
  • .hooks
    • init
    • setScale
    • setCursor
    • setSelect
    • setSeries
    • setData
    • setSize
    • drawClear
    • drawAxes
    • drawSeries
    • draw
    • ready
    • destroy
  • .plugins
  • .title
  • .id, .class
  • .width, .height
  • .gutters: {x, y}
  • .scales
    • .auto
    • .time
    • .range (fn and array)
    • .from
    • .distr
    • .min, .max
  • .axes
    • .show
    • .side
    • .stroke
    • .scale
    • .incrs
    • .split
    • .values (fn and stampsCfg array)
    • .space (fn and number)
    • .size
    • .gap
    • .font
    • .label
    • .labelSize
    • .labelFont
    • .grid
      • .show
      • .stroke
      • .width
      • .dash
    • .ticks
      • .show
      • .stroke
      • .width
      • .dash
      • .size
  • .series
    • .show
    • .paths
    • .scale
    • .label
    • .stroke
    • .fill
    • .alpha
    • .width
    • .dash
    • .value
    • .values
    • .band
    • .spanGaps
    • .class
    • .points
      • .show (fn or bool)
      • .size
      • .width
      • .stroke
      • .fill
  • .cursor
    • .show
    • .points
      • .show (fn or bool)
    • .x, .y
    • .drag: {setSelect, setScale, x, y}
    • .sync: {key, setSeries}
    • .focus: {prox}
    • .lock
  • .focus: {alpha}
  • .select
    • .show
  • .legend
    • .show

instance properties and methods:

  • .root
  • .width, .height
  • .ctx
  • .bbox
  • .redraw()
  • .scales, .axes, .series, .cursor, .hooks, .data, .ctx, .select (state inference)
  • .batch()
  • .setData(), .setScale(), .setCursor(), .setSeries(), .setSelect(), .setSize()
  • .destroy()
  • .tzDate
  • .posToIdx(left)
  • .posToVal(left/top, scaleKey)
  • .valToPos(val, scaleKey)

static properties and functions:

  • uPlot.fmtDate
  • uPlot.tzDate
  • uPlot.rangeNum
  • uPlot.assign
@leeoniya leeoniya added the docs Improvements or additions to documentation label Nov 5, 2019
@leeoniya leeoniya added this to the 1.0.0 milestone Nov 5, 2019
@leeoniya leeoniya changed the title Docs API Docs Nov 5, 2019
@leeoniya leeoniya pinned this issue Feb 19, 2020
@leeoniya leeoniya changed the title API Docs 馃摉 API Docs Mar 12, 2020
@leeoniya
Copy link
Owner Author

leeoniya commented Mar 21, 2020

i guess this can be it for now: https://github.com/leeoniya/uPlot/blob/master/dist/uPlot.d.ts

@Joelius300

This comment has been minimized.

@leeoniya
Copy link
Owner Author

@Joelius300 thanks! i updated the link in the comment, too.

Repository owner deleted a comment from wimtiaz14 Jun 6, 2020
@leeoniya leeoniya unpinned this issue Dec 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants
@leeoniya @Joelius300 and others