@stealthscale/component-charts 0.2.2 → 0.2.3

package/dist/pages/candlestick-chart/candlestick-chart.props.js

@@ -0,0 +1,3 @@
+export const dropped = {"CandlestickChartProps": {"conditions": 284, "foreign": 1039}, "CaptionProps": {"conditions": 284, "foreign": 1041}, "CrosshairProps": {"conditions": 0, "foreign": 0}, "EmptyProps": {"conditions": 284, "foreign": 1041}, "KeyItemProps": {"conditions": 284, "foreign": 1042}, "KeyProps": {"conditions": 284, "foreign": 1041}, "LegendProps": {"conditions": 284, "foreign": 1044}, "PlotProps": {"conditions": 284, "foreign": 1040}, "RootProps": {"conditions": 284, "foreign": 1041}, "TooltipProps": {"conditions": 0, "foreign": 0}};
+export const parts = {"CandlestickChartProps": [{"accepts": "boolean", "fallback": "", "kind": "option", "name": "animate", "refers": [], "required": false, "says": "Whether the candles grow in, which they do only outside reduced motion."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "bodyLabel", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Name of the body in the key."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "caption", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Finding the chart shows, in words, which names the figure."}, {"accepts": "Extract<keyof Row, string>", "fallback": "", "kind": "option", "name": "categoryKey", "refers": [], "required": true, "says": "Field of each row the category axis reads, such as a trading day."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "changeLabel", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Name of the change in the tooltip."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "children", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Recharts elements rendered inside the chart after the candles, such as a `ReferenceLine`."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "closeLabel", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Name of the closing price in the tooltip."}, {"accepts": "readonly Row[]", "fallback": "", "kind": "option", "name": "data", "refers": ["kit.Row"], "required": true, "says": "Rows of the periods, each with `open`, `high`, `low` and `close`. A row without a finite number in each is left out."}, {"accepts": "number", "fallback": "", "kind": "option", "name": "defaultIndex", "refers": [], "required": false, "says": "Index of the period the tooltip shows when the chart first renders. None unless stated."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "downLabel", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Name of a falling candle's color in the key."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "empty", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Message the chart renders in the plot's place while no row has a candle."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "flatLabel", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Name of a flat candle's color in the key, which renders while the chart has a flat candle."}, {"accepts": "boolean", "fallback": "", "kind": "option", "name": "grid", "refers": [], "required": false, "says": "Whether lines cross the plot at the value ticks."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "highLabel", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Name of the highest price in the tooltip."}, {"accepts": "string", "fallback": "", "kind": "option", "name": "label", "refers": [], "required": true, "says": "Accessible name of the chart's keyboard layer, such as \"Daily prices of ACME\"."}, {"accepts": "DateTimeFormatOptions", "fallback": "", "kind": "option", "name": "labelOptions", "refers": [], "required": false, "says": "`Intl.DateTimeFormat` options the category ticks and the tooltip's heading are written with, for periods given as dates. The category as it is unless stated."}, {"accepts": "boolean", "fallback": "", "kind": "option", "name": "legend", "refers": [], "required": false, "says": "Whether the key naming the colors and the parts renders below the plot."}, {"accepts": "string", "fallback": "", "kind": "option", "name": "locale", "refers": [], "required": false, "says": "Locale the values are written in. The locale in scope unless stated."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "lowLabel", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Name of the lowest price in the tooltip."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "openLabel", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Name of the opening price in the tooltip."}, {"accepts": "\"golden\" | \"landscape\" | \"portrait\" | \"rows\" | \"square\" | \"ultrawide\" | \"video\" | \"wide\"", "fallback": "", "kind": "variant", "name": "ratio", "refers": [], "required": false, "says": "Aspect ratio of the plot and of the empty state in its place, one of the theme's ratios, or `rows` for a plot as tall as its rows."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "upLabel", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Name of a rising candle's color in the key."}, {"accepts": "AxisDomain", "fallback": "", "kind": "option", "name": "valueDomain", "refers": ["recharts.AxisDomain", "recharts.AxisDomainItem", "recharts.NumberDomain"], "required": false, "says": "Domain of the value axis in recharts' terms. Rounded around the prices unless stated."}, {"accepts": "NumberFormatOptions", "fallback": "", "kind": "option", "name": "valueOptions", "refers": [], "required": false, "says": "`Intl.NumberFormat` options the value ticks, the prices and the change are written with."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "wickLabel", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Name of the wick in the key."}], "CaptionProps": [], "CrosshairProps": [{"accepts": "string", "fallback": "", "kind": "option", "name": "dataKey", "refers": [], "required": true, "says": "Key of the series whose value the guide marks."}], "EmptyProps": [], "KeyItemProps": [{"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "glyph", "refers": ["react.ReactElement", "react.ReactPortal"], "required": true, "says": "Picture of the part, an `svg` the recipe sizes to the text."}], "KeyProps": [], "LegendProps": [{"accepts": "string", "fallback": "", "kind": "option", "name": "label", "refers": [], "required": false, "says": "Name of the group of buttons, read before the first one."}], "PlotProps": [{"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "center", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Figure over the middle of the plot, such as the total in a donut's hole."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "centerLabel", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Words under the figure in the middle, such as what the total counts."}, {"accepts": "ReactElement<unknown, string | JSXElementConstructor<any>>", "fallback": "", "kind": "option", "name": "children", "refers": ["react.ReactElement"], "required": true, "says": "The recharts chart, such as a `LineChart` with its axes and marks."}], "RootProps": [{"accepts": "ChartApi<unknown>", "fallback": "", "kind": "option", "name": "chart", "refers": ["kit.ChartApi", "kit.Series"], "required": true, "says": "Chart `useChart` returns, which every part reads."}, {"accepts": "\"golden\" | \"landscape\" | \"portrait\" | \"rows\" | \"square\" | \"ultrawide\" | \"video\" | \"wide\"", "fallback": "", "kind": "variant", "name": "ratio", "refers": [], "required": false, "says": "Aspect ratio of the plot and of the empty state in its place, one of the theme's ratios, or `rows` for a plot as tall as its rows."}], "TooltipProps": [{"accepts": "boolean", "fallback": "", "kind": "option", "name": "accessibilityLayer", "refers": [], "required": false, "says": "Whether recharts' keyboard layer is on, which makes the panel assertive. Recharts passes it."}, {"accepts": "boolean", "fallback": "", "kind": "option", "name": "active", "refers": [], "required": false, "says": "Whether recharts shows the tooltip. Recharts passes it."}, {"accepts": "((entry: TooltipEntry) => string)", "fallback": "", "kind": "option", "name": "entryColor", "refers": ["kit.TooltipEntry"], "required": false, "says": "Returns the CSS color of an entry's swatch, for a mark whose color changes from row to row. The series' color unless stated."}, {"accepts": "((value: unknown) => string)", "fallback": "", "kind": "option", "name": "formatLabel", "refers": [], "required": false, "says": "Writes the category, such as a day. The category's own text unless stated."}, {"accepts": "((value: unknown, entry: TooltipEntry) => string)", "fallback": "", "kind": "option", "name": "formatValue", "refers": ["kit.TooltipEntry"], "required": false, "says": "Writes each series' value, such as an amount in a currency, given the value and its entry. A number in the chart's locale unless stated, and a band's two ends as a range."}, {"accepts": "((entries: readonly TooltipEntry[]) => ReactNode)", "fallback": "", "kind": "option", "name": "headingOf", "refers": ["kit.TooltipEntry"], "required": false, "says": "Returns the heading from the entries shown, for a tooltip about one point rather than one category, such as a scatter's. The category, written by `formatLabel`, unless stated."}, {"accepts": "unknown", "fallback": "", "kind": "option", "name": "label", "refers": [], "required": false, "says": "Category the tooltip is for. Recharts passes it."}, {"accepts": "((entry: TooltipEntry) => ReactNode)", "fallback": "", "kind": "option", "name": "nameOf", "refers": ["kit.TooltipEntry"], "required": false, "says": "Returns a row's name, such as the title of the axis a scatter's value is on. The series' label unless stated."}, {"accepts": "((label: unknown) => readonly TooltipNote[])", "fallback": "", "kind": "option", "name": "notesOf", "refers": [], "required": false, "says": "Returns the notes about the category, such as the annotations at it, which render after the rows. None unless stated."}, {"accepts": "readonly TooltipEntry[]", "fallback": "", "kind": "option", "name": "payload", "refers": ["kit.TooltipEntry"], "required": false, "says": "Values at the category, one per series. Recharts passes them."}, {"accepts": "((entries: readonly TooltipEntry[]) => readonly TooltipRow[])", "fallback": "", "kind": "option", "name": "rowsOf", "refers": ["kit.TooltipEntry"], "required": false, "says": "Returns the rows of a tooltip about one datum with several numbers, such as a box's median and quartiles, from the entries shown. The rows render without a swatch. A row per shown series unless stated."}]};
+export const shapes = {"react.ReactElement": [{"accepts": "string | JSXElementConstructor<any>", "name": "type", "says": ""}, {"accepts": "unknown", "name": "props", "says": ""}, {"accepts": "string | null", "name": "key", "says": ""}], "react.ReactPortal": [{"accepts": "ReactNode", "name": "children", "says": ""}, {"accepts": "string | JSXElementConstructor<any>", "name": "type", "says": ""}, {"accepts": "unknown", "name": "props", "says": ""}, {"accepts": "string | null", "name": "key", "says": ""}], "recharts.AxisDomain": [{"accepts": "", "name": "readonly string[]", "says": ""}, {"accepts": "", "name": "readonly number[]", "says": ""}, {"accepts": "", "name": "([dataMin, dataMax]: NumberDomain, allowDataOverflow: boolean) => NumberDomain", "says": ""}, {"accepts": "", "name": "readonly [AxisDomainItem, AxisDomainItem]", "says": ""}], "recharts.AxisDomainItem": [{"accepts": "", "name": "string", "says": ""}, {"accepts": "", "name": "number", "says": ""}, {"accepts": "", "name": "(d: number) => string | number", "says": ""}], "kit.ChartApi": [{"accepts": "(key: string) => string", "name": "color", "says": "Returns the CSS value of a series' color, or `currentColor` for a key no series has."}, {"accepts": "unknown[]", "name": "data", "says": "Rows the chart plots, the array the caller passed, which a recharts chart takes as `data`."}, {"accepts": "(options?: DateTimeFormatOptions) => (value: unknown) => string", "name": "formatDate", "says": "Returns a function that writes an instant in the chart's locale."}, {"accepts": "(options?: NumberFormatOptions) => (value: unknown) => string", "name": "formatNumber", "says": "Returns a function that writes a number in the chart's locale."}, {"accepts": "(key: string) => boolean", "name": "hidden", "says": "Returns whether the legend hides a series."}, {"accepts": "(key?: string) => void", "name": "highlight", "says": "Points the legend at a series, or at none without a key. The pointer and focus on a legend item call it."}, {"accepts": "string", "name": "highlighted", "says": "Key of the series the legend points at. Every other series' `opacity` is the faded one."}, {"accepts": "string", "name": "locale", "says": "Locale the chart writes in: `locale`, else the nearest `LocaleProvider`'s, else the runtime's."}, {"accepts": "(key: string) => string", "name": "opacity", "says": "Returns the CSS value of a series' opacity, which a mark takes as `opacity`, or 1 for a key no series has."}, {"accepts": "(key: string, alone: boolean) => void", "name": "press", "says": "Hides or shows series after a press in the legend: the pressed series switched for a plain press, the pressed series alone for a press with Ctrl or Cmd."}, {"accepts": "readonly Series[]", "name": "series", "says": "Series as the chart resolved them, in order."}], "kit.Series": [{"accepts": "string", "name": "color", "says": "CSS value of the series' color, which a mark takes as its `stroke` or `fill`."}, {"accepts": "boolean", "name": "hidden", "says": "Whether the legend hides the series. A mark takes it as `hide`."}, {"accepts": "string", "name": "key", "says": "Field of each row the series reads."}, {"accepts": "ReactNode", "name": "label", "says": "Name the tooltip and the legend show."}, {"accepts": "string", "name": "opacity", "says": "CSS value of the series' opacity, which a mark takes as `opacity`: the recipe's faded opacity while the legend points at another series, else 1."}], "kit.TooltipEntry": [{"accepts": "unknown", "name": "dataKey", "says": "Field the series reads, which is the series' key on a cartesian chart."}, {"accepts": "unknown", "name": "name", "says": "Name of the entry, which is the series' key for a pie's sector and a band."}, {"accepts": "unknown", "name": "payload", "says": "Row the entry was read from."}, {"accepts": "unknown", "name": "value", "says": "Value of the series at the category, or a band's two ends."}]};