@turquoisehealth/pit-viper 2.254.0 → 2.255.1

package/pv-components/dist/vue/base/components/base/PvBoxPlot/PvBoxPlot.vue.d.ts

@@ -0,0 +1,15 @@
+import { PvBoxPlotMarker, PvBoxPlotProps, PvBoxPlotStats } from './types';
+import { DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+declare const _default: DefineComponent<PvBoxPlotProps, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<PvBoxPlotProps> & Readonly<{}>, {
+    highlight: number | null;
+    ariaLabel: string;
+    markers: PvBoxPlotMarker[];
+    height: number;
+    hideLabels: boolean;
+    stats: PvBoxPlotStats | null;
+    valueFormatter: (value: number) => string;
+    xMax: number | null;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {
+    container: HTMLDivElement;
+}, HTMLDivElement>;
+export default _default;

package/pv-components/dist/vue/base/components/base/PvBoxPlot/helpers.d.ts

@@ -0,0 +1,7 @@
+/** Rounds `value` up to a clean axis bound. Returns 100 for zero or negative input so an empty axis still has a scale. */
+export declare const niceCeiling: (value: number) => number;
+/** Tick interval that gives about five ticks on an axis from 0 to `max`. */
+export declare const niceStep: (max: number) => number;
+/** Tick positions from 0 to `max`, inclusive. */
+export declare const axisTicks: (max: number) => number[];
+export declare const formatWholeDollars: (value: number) => string;

package/pv-components/dist/vue/base/components/base/PvBoxPlot/types.d.ts

@@ -0,0 +1,33 @@
+export interface PvBoxPlotMarker {
+    /** Dot color: any CSS color, including a var(). Defaults to coral ($dataviz-3). */
+    color?: string;
+    /** Optional label drawn above the plot with the formatted value, e.g. "Anchor". */
+    label?: string;
+    /** Position of the dot on the axis. */
+    value: number;
+}
+export interface PvBoxPlotStats {
+    p10: number;
+    p25: number;
+    p50: number;
+    p75: number;
+    p90: number;
+}
+export interface PvBoxPlotProps {
+    /** Accessible description of the plot. Defaults to one generated from the stats and markers. */
+    ariaLabel?: string;
+    /** Height of the plot in pixels. Defaults to 180. The width always fills the container. */
+    height?: number;
+    /** Transient marker, e.g. the rate of a hovered table row: a dashed line with a small dot. Drawn above the markers. */
+    highlight?: number | null;
+    /** Hides the percentile labels, the P10 and P90 amounts, and the median callout. Marker labels still show. */
+    hideLabels?: boolean;
+    /** Persistent dots on the axis, such as an anchor or an offer. */
+    markers?: PvBoxPlotMarker[];
+    /** The distribution: whiskers P10 to P90, box P25 to P75, a line at the median. Nothing renders without it. */
+    stats?: PvBoxPlotStats | null;
+    /** Formats every amount on the axis and in the labels. Defaults to whole US dollars, e.g. "$1,250". */
+    valueFormatter?: (value: number) => string;
+    /** Fixed upper bound of the axis, so the plot can line up with a sibling chart. Defaults to a rounded bound above P90 and every marker. */
+    xMax?: number | null;
+}

package/pv-components/dist/vue/base/components/base/index.d.ts

@@ -68,6 +68,7 @@ export { default as PvTree } from './PvTree/PvTree.vue';
 export { default as PvTreeGroup } from './PvTree/PvTreeGroup.vue';
 export { default as PvProgressBar } from './PvProgressBar/PvProgressBar.vue';
 export { default as PvDistributionBar } from './PvDistributionBar/PvDistributionBar.vue';
+export { default as PvBoxPlot } from './PvBoxPlot/PvBoxPlot.vue';
 export { default as PvFilterPanel } from './PvFilterPanel/PvFilterPanel.vue';
 export { default as PvFilterModal } from './PvFilterModal/PvFilterModal.vue';
 export { default as PvHorizontalScroller } from './PvHorizontalScroller/PvHorizontalScroller.vue';
@@ -98,6 +99,7 @@ export type { RadioGroupOption } from './PvRadioGroup/types';
 export type { PvTableOfContentsItem } from './PvTableOfContents/types';
 export type { PvHorizontalScrollerProps } from './PvHorizontalScroller/types';
 export type { PvFilterModalProps } from './PvFilterModal/types';
+export type { PvBoxPlotMarker, PvBoxPlotProps, PvBoxPlotStats } from './PvBoxPlot/types';
 export type { PvHoverActionMenuPosition } from './PvHoverActionMenu/types';
 export type { PvMenuChildrenDisplay } from './PvMenu/types';
 export type { PvFilterPanelAggregateFieldHierarchy, PvFilterPanelColDef, PvFilterPanelColDefContext, PvFilterPanelControlChange, PvFilterPanelFilterChangeEvent, PvFilterPanelFilterChangeReason, PvFilterPanelFilterGroup, PvFilterPanelFilterModel, PvFilterPanelFilterModelType, PvFilterPanelFilterType, PvFilterPanelOption, PvFilterPanelOptionsHandler, PvFilterPanelOptionsHandlerParams, PvFilterPanelOptionsHandlerReason, PvFilterPanelOptionsResponse, PvFilterPanelOptionRawValue, PvFilterPanelProps, PvFilterPanelRangeConfig, PvFilterPanelResultCount, PvFilterPanelSuggestion, PvFilterStore, PvFilterStoreFetchOptionsParams, } from './PvFilterPanel/types';