@icij/murmur-next 4.0.0 → 4.0.1

package/dist/lib/datavisualisations/BarChart.vue.d.ts

@@ -0,0 +1,234 @@
+/// <reference types="@/shims-vue" />
+/// <reference types="vue-i18n" />
+declare const _default: import('../../node_modules/vue').DefineComponent<{
+    chartHeightRatio: {
+        type: NumberConstructor; /**
+         * Color of each highlighted bar (uses the CSS variable --bar-highlight-color by default)
+         */
+    }; /**
+     * Color of each highlighted bar (uses the CSS variable --bar-highlight-color by default)
+     */
+    data: {
+        default: () => string | any[];
+        validator(value: string): boolean;
+        type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+    };
+    dataUrlType: {
+        default: string;
+        validator(value: string): boolean;
+        type: StringConstructor;
+    };
+    socialMode: {
+        type: BooleanConstructor;
+    };
+    socialModeRatio: {
+        default: number;
+        type: NumberConstructor;
+    };
+    /**
+     * Height of each bar
+     */
+    barHeight: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Distance between each bar
+     */
+    barGap: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Color of each bar (uses the CSS variable --bar-color by default)
+     */
+    barColor: {
+        type: StringConstructor;
+        default: null;
+    };
+    /**
+     * Color of each highlighted bar (uses the CSS variable --bar-highlight-color by default)
+     */
+    barHighlightColor: {
+        type: StringConstructor;
+        default: null;
+    };
+    /**
+     * Enforce a width for each bar's label
+     */
+    fixedLabelWidth: {
+        type: NumberConstructor;
+        default: null;
+    };
+    /**
+     * Enforce a width for each bar's value
+     */
+    fixedValueWidth: {
+        type: NumberConstructor;
+        default: null;
+    };
+    /**
+     * Distance between a bar and its label
+     */
+    labelGap: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Distande between a bar and its value
+     */
+    valueGap: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Sort bars by one or several keys.
+     */
+    sortBy: {
+        type: (StringConstructor | ArrayConstructor)[];
+        default: null;
+    };
+    /**
+     * Function to apply to format x axis ticks (bar value). It can be a
+     * function returning the formatted value or a d3's formatter string.
+     */
+    xAxisTickFormat: {
+        type: (StringConstructor | FunctionConstructor)[];
+        default: () => {
+            <T>(value: T): T;
+            (): undefined;
+        };
+    };
+}, {
+    el: import('../../node_modules/vue').Ref<null>;
+    dataHasHighlights: any;
+    width: import('../../node_modules/vue').Ref<number>;
+    height: import('../../node_modules/vue').ComputedRef<number>;
+    margin: import('../../node_modules/vue').ComputedRef<{
+        left: any;
+        right: number;
+        top: number;
+        bottom: number;
+    }>;
+    labels: import('../../node_modules/vue').ComputedRef<any>;
+    bars: import('../../node_modules/vue').ComputedRef<any>;
+    formatXDatum: (d: any) => any;
+}, unknown, {}, {}, import('../../node_modules/vue').ComponentOptionsMixin, import('../../node_modules/vue').ComponentOptionsMixin, ("resized" | "loaded")[], "resized" | "loaded", import('../../node_modules/vue').PublicProps, Readonly<import('../../node_modules/vue').ExtractPropTypes<{
+    chartHeightRatio: {
+        type: NumberConstructor; /**
+         * Color of each highlighted bar (uses the CSS variable --bar-highlight-color by default)
+         */
+    }; /**
+     * Color of each highlighted bar (uses the CSS variable --bar-highlight-color by default)
+     */
+    data: {
+        default: () => string | any[];
+        validator(value: string): boolean;
+        type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+    };
+    dataUrlType: {
+        default: string;
+        validator(value: string): boolean;
+        type: StringConstructor;
+    };
+    socialMode: {
+        type: BooleanConstructor;
+    };
+    socialModeRatio: {
+        default: number;
+        type: NumberConstructor;
+    };
+    /**
+     * Height of each bar
+     */
+    barHeight: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Distance between each bar
+     */
+    barGap: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Color of each bar (uses the CSS variable --bar-color by default)
+     */
+    barColor: {
+        type: StringConstructor;
+        default: null;
+    };
+    /**
+     * Color of each highlighted bar (uses the CSS variable --bar-highlight-color by default)
+     */
+    barHighlightColor: {
+        type: StringConstructor;
+        default: null;
+    };
+    /**
+     * Enforce a width for each bar's label
+     */
+    fixedLabelWidth: {
+        type: NumberConstructor;
+        default: null;
+    };
+    /**
+     * Enforce a width for each bar's value
+     */
+    fixedValueWidth: {
+        type: NumberConstructor;
+        default: null;
+    };
+    /**
+     * Distance between a bar and its label
+     */
+    labelGap: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Distande between a bar and its value
+     */
+    valueGap: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Sort bars by one or several keys.
+     */
+    sortBy: {
+        type: (StringConstructor | ArrayConstructor)[];
+        default: null;
+    };
+    /**
+     * Function to apply to format x axis ticks (bar value). It can be a
+     * function returning the formatted value or a d3's formatter string.
+     */
+    xAxisTickFormat: {
+        type: (StringConstructor | FunctionConstructor)[];
+        default: () => {
+            <T>(value: T): T;
+            (): undefined;
+        };
+    };
+}>> & {
+    onResized?: ((...args: any[]) => any) | undefined;
+    onLoaded?: ((...args: any[]) => any) | undefined;
+}, {
+    data: string | Record<string, any> | unknown[];
+    barHeight: number;
+    barGap: number;
+    barColor: string;
+    barHighlightColor: string;
+    fixedLabelWidth: number;
+    fixedValueWidth: number;
+    labelGap: number;
+    valueGap: number;
+    sortBy: string | unknown[];
+    xAxisTickFormat: string | Function;
+    dataUrlType: string;
+    socialMode: boolean;
+    socialModeRatio: number;
+}, {}>;
+export default _default;

package/dist/lib/datavisualisations/ColumnChart.vue.d.ts

@@ -0,0 +1,404 @@
+/// <reference types="@/shims-vue" />
+/// <reference types="vue-i18n" />
+import { ComponentPublicInstance, PropType } from '../../node_modules/vue';
+type ColumnBar = {
+    datum: {
+        [timeSerie: string]: any;
+    };
+    width: number;
+    height: number;
+    x: number;
+    y: number;
+};
+declare const _default: import('../../node_modules/vue').DefineComponent<{
+    chartHeightRatio: {
+        type: NumberConstructor;
+    };
+    data: {
+        default: () => string | any[];
+        validator(value: string): boolean;
+        type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+    };
+    dataUrlType: {
+        default: string;
+        validator(value: string): boolean;
+        type: StringConstructor;
+    };
+    socialMode: {
+        type: BooleanConstructor;
+    };
+    socialModeRatio: {
+        default: number;
+        type: NumberConstructor;
+    };
+    /**
+     * Color of each column (uses the CSS variable --column-color by default)
+     */
+    columnColor: {
+        type: PropType<string>;
+        default: null;
+    };
+    /**
+     * Color of each highlighted column (uses the CSS variable --column-color by default)
+     */
+    columnHighlightColor: {
+        type: PropType<string>;
+        default: null;
+    };
+    /**
+     * Enforce the height of the chart (regardless of the width or the social mode)
+     */
+    fixedHeight: {
+        type: PropType<number>;
+        default: null;
+    };
+    /**
+     * Enforce a width for each column's label
+     */
+    fixedLabelWidth: {
+        type: PropType<number>;
+        default: null;
+    };
+    /**
+     * Name of the series (to get the value from in the data collection objects)
+     */
+    seriesName: {
+        type: PropType<string>;
+        default: string;
+    };
+    /**
+     * Hide x axis ticks when no enough space
+     */
+    xAxisTickCollapse: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * Function to apply to format x axis ticks
+     */
+    xAxisTickFormat: {
+        type: PropType<string | Function>;
+        default: () => {
+            <T>(value: T): T;
+            (): undefined;
+        };
+    };
+    /**
+     * Definition of x axis ticks
+     */
+    xAxisTicks: {
+        type: PropType<string[] | null>;
+        default: null;
+    };
+    /**
+     * Function to apply to format y axis ticks
+     */
+    yAxisTickFormat: {
+        type: PropType<string | Function>;
+        default: () => {
+            <T>(value: T): T;
+            (): undefined;
+        };
+    };
+    /**
+     * Definition of y axis ticks
+     */
+    yAxisTicks: {
+        type: PropType<number | object>;
+        default: number;
+    };
+    /**
+     * Sort columns by one or several keys.
+     */
+    sortBy: {
+        type: PropType<string | string[]>;
+        default: null;
+    };
+    /**
+     * Key to use for timeseries
+     */
+    timeseriesKey: {
+        type: PropType<string>;
+        default: string;
+    };
+    /**
+     * Set max value instead of extracting it from the data.
+     */
+    maxValue: {
+        type: PropType<number>;
+        default: null;
+    };
+    /**
+     * Hide bar tooltips
+     */
+    noTooltips: {
+        type: PropType<boolean>;
+    };
+    /**
+     * Hide x axis
+     */
+    noXAxis: {
+        type: PropType<boolean>;
+    };
+    /**
+     * Hide y axis
+     */
+    noYAxis: {
+        type: PropType<boolean>;
+    };
+    /**
+     * Bar padding as a portion of each bar width
+     */
+    barPadding: {
+        type: PropType<number>;
+        default: number;
+    };
+    /**
+     * Bar margin in pixel
+     */
+    barMargin: {
+        type: PropType<number>;
+        default: number;
+    };
+    /**
+     * A list of highlighted key
+     */
+    highlights: {
+        type: PropType<string[]>;
+        default: () => never[];
+    };
+    /**
+     * Show a "placeholder" behind every bar
+     */
+    stripped: {
+        type: PropType<boolean>;
+    };
+    /**
+     * Show a "placeholder" behind every bar on hover
+     */
+    hover: {
+        type: PropType<boolean>;
+    };
+}, {
+    el: import('../../node_modules/vue').Ref<ComponentPublicInstance<HTMLElement> | null>;
+    dataHasHighlights: any;
+    width: import('../../node_modules/vue').Ref<number>;
+    height: import('../../node_modules/vue').Ref<number>;
+    margin: import('../../node_modules/vue').ComputedRef<{
+        left: number;
+        right: number;
+        top: number;
+        bottom: number;
+    }>;
+    padded: import('../../node_modules/vue').ComputedRef<{
+        width: number;
+        height: number;
+    }>;
+    shownTooltip: import('../../node_modules/vue').Ref<number>;
+    bars: import('../../node_modules/vue').ComputedRef<ColumnBar[]>;
+    select: ({ datum }: {
+        datum: any;
+    }) => void;
+    highlighted: (datum: any) => boolean;
+    barTooltipStyle: (bar: {
+        x: number;
+        y: number;
+        width: number;
+    }) => {
+        top: string;
+        left: string;
+    };
+    formatYDatum: (d: any) => any;
+    formatXDatum: (d: any) => any;
+}, unknown, {}, {}, import('../../node_modules/vue').ComponentOptionsMixin, import('../../node_modules/vue').ComponentOptionsMixin, {}, string, import('../../node_modules/vue').PublicProps, Readonly<import('../../node_modules/vue').ExtractPropTypes<{
+    chartHeightRatio: {
+        type: NumberConstructor;
+    };
+    data: {
+        default: () => string | any[];
+        validator(value: string): boolean;
+        type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+    };
+    dataUrlType: {
+        default: string;
+        validator(value: string): boolean;
+        type: StringConstructor;
+    };
+    socialMode: {
+        type: BooleanConstructor;
+    };
+    socialModeRatio: {
+        default: number;
+        type: NumberConstructor;
+    };
+    /**
+     * Color of each column (uses the CSS variable --column-color by default)
+     */
+    columnColor: {
+        type: PropType<string>;
+        default: null;
+    };
+    /**
+     * Color of each highlighted column (uses the CSS variable --column-color by default)
+     */
+    columnHighlightColor: {
+        type: PropType<string>;
+        default: null;
+    };
+    /**
+     * Enforce the height of the chart (regardless of the width or the social mode)
+     */
+    fixedHeight: {
+        type: PropType<number>;
+        default: null;
+    };
+    /**
+     * Enforce a width for each column's label
+     */
+    fixedLabelWidth: {
+        type: PropType<number>;
+        default: null;
+    };
+    /**
+     * Name of the series (to get the value from in the data collection objects)
+     */
+    seriesName: {
+        type: PropType<string>;
+        default: string;
+    };
+    /**
+     * Hide x axis ticks when no enough space
+     */
+    xAxisTickCollapse: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * Function to apply to format x axis ticks
+     */
+    xAxisTickFormat: {
+        type: PropType<string | Function>;
+        default: () => {
+            <T>(value: T): T;
+            (): undefined;
+        };
+    };
+    /**
+     * Definition of x axis ticks
+     */
+    xAxisTicks: {
+        type: PropType<string[] | null>;
+        default: null;
+    };
+    /**
+     * Function to apply to format y axis ticks
+     */
+    yAxisTickFormat: {
+        type: PropType<string | Function>;
+        default: () => {
+            <T>(value: T): T;
+            (): undefined;
+        };
+    };
+    /**
+     * Definition of y axis ticks
+     */
+    yAxisTicks: {
+        type: PropType<number | object>;
+        default: number;
+    };
+    /**
+     * Sort columns by one or several keys.
+     */
+    sortBy: {
+        type: PropType<string | string[]>;
+        default: null;
+    };
+    /**
+     * Key to use for timeseries
+     */
+    timeseriesKey: {
+        type: PropType<string>;
+        default: string;
+    };
+    /**
+     * Set max value instead of extracting it from the data.
+     */
+    maxValue: {
+        type: PropType<number>;
+        default: null;
+    };
+    /**
+     * Hide bar tooltips
+     */
+    noTooltips: {
+        type: PropType<boolean>;
+    };
+    /**
+     * Hide x axis
+     */
+    noXAxis: {
+        type: PropType<boolean>;
+    };
+    /**
+     * Hide y axis
+     */
+    noYAxis: {
+        type: PropType<boolean>;
+    };
+    /**
+     * Bar padding as a portion of each bar width
+     */
+    barPadding: {
+        type: PropType<number>;
+        default: number;
+    };
+    /**
+     * Bar margin in pixel
+     */
+    barMargin: {
+        type: PropType<number>;
+        default: number;
+    };
+    /**
+     * A list of highlighted key
+     */
+    highlights: {
+        type: PropType<string[]>;
+        default: () => never[];
+    };
+    /**
+     * Show a "placeholder" behind every bar
+     */
+    stripped: {
+        type: PropType<boolean>;
+    };
+    /**
+     * Show a "placeholder" behind every bar on hover
+     */
+    hover: {
+        type: PropType<boolean>;
+    };
+}>>, {
+    data: string | Record<string, any> | unknown[];
+    fixedLabelWidth: number;
+    sortBy: string | string[];
+    xAxisTickFormat: string | Function;
+    dataUrlType: string;
+    socialMode: boolean;
+    socialModeRatio: number;
+    columnColor: string;
+    columnHighlightColor: string;
+    fixedHeight: number;
+    seriesName: string;
+    xAxisTickCollapse: boolean;
+    xAxisTicks: string[] | null;
+    yAxisTickFormat: string | Function;
+    yAxisTicks: number | object;
+    timeseriesKey: string;
+    maxValue: number;
+    barPadding: number;
+    barMargin: number;
+    highlights: string[];
+}, {}>;
+export default _default;