@icij/murmur-next 4.0.0 → 4.0.1

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

@@ -0,0 +1,412 @@
+/// <reference types="@/shims-vue" />
+/// <reference types="vue-i18n" />
+import * as d3 from 'd3';
+import { ComponentPublicInstance } from '../../node_modules/vue';
+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;
+    };
+    /**
+     * Field of each object containing data (for each group)
+     */
+    keys: {
+        type: ArrayConstructor;
+        default: () => never[];
+    };
+    /**
+     * Group name to display in the legend
+     */
+    groups: {
+        type: ArrayConstructor;
+        default: () => never[];
+    };
+    /**
+     * Colors of each bar group
+     */
+    barColors: {
+        type: ArrayConstructor;
+        default: () => never[];
+    };
+    /**
+     * Max with of each bar.
+     */
+    barMaxWidth: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Hide bars that have no values.
+     */
+    hideEmptyValues: {
+        type: BooleanConstructor;
+    };
+    /**
+     * Hide the legend.
+     */
+    hideLegend: {
+        type: BooleanConstructor;
+    };
+    /**
+     * Enforce the height of the chart (regardless of the width or number of row)
+     */
+    fixedHeight: {
+        type: NumberConstructor;
+        default: null;
+    };
+    /**
+     * Function to apply to format x axis ticks
+     */
+    xAxisTickFormat: {
+        type: (StringConstructor | FunctionConstructor)[];
+        default: () => {
+            <T>(value: T): T;
+            (): undefined;
+        };
+    };
+    /**
+     * Function to apply to format y axis ticks (bars value). It can be a
+     * function returning the formatted value or a d3's formatter string.
+     */
+    yAxisTickFormat: {
+        type: (StringConstructor | FunctionConstructor)[];
+        default: () => {
+            <T>(value: T): T;
+            (): undefined;
+        };
+    };
+    /**
+     * Padding on y axis ticks
+     */
+    yAxisTickPadding: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Field containing the label for each column
+     */
+    labelField: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Sort groups by one or several keys.
+     */
+    sortBy: {
+        type: (StringConstructor | ArrayConstructor)[];
+        default: null;
+    };
+    /**
+     * Column height is relative to each group's total
+     */
+    relative: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * A list of highlighted groups
+     */
+    highlights: {
+        type: ArrayConstructor;
+        default: () => never[];
+    };
+    /**
+     * Delay to apply when set the first highlight
+     */
+    highlightDelay: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * A list of entire column to highlight
+     */
+    columnHighlights: {
+        type: ArrayConstructor;
+        default: () => never[];
+    };
+    /**
+     * Delay to apply when restoring highlights to initial state
+     */
+    restoreHighlightDelay: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Deactivate direct labeling on bars
+     */
+    noDirectLabeling: {
+        type: BooleanConstructor;
+    };
+    /**
+     * Set max value instead of extracting it from the data.
+     */
+    maxValue: {
+        type: NumberConstructor;
+        default: null;
+    };
+    /**
+      * Function to define tooltip content.
+     */
+    tooltipDisplay: {
+        type: FunctionConstructor;
+        default: ({ formattedKey, formattedValue }: {
+            formattedKey: string;
+            formattedValue: string;
+        }) => string;
+    };
+    /**
+     * Hide bar tooltips
+     */
+    noTooltips: {
+        type: BooleanConstructor;
+    };
+}, {
+    barTooltipDelay: import('../../node_modules/vue').ComputedRef<number>;
+    colorScale: import('../../node_modules/vue').ComputedRef<d3.ScaleOrdinal<string, unknown, never>>;
+    dataHasHighlights: any;
+    discoveredKeys: import('../../node_modules/vue').ComputedRef<any[]>;
+    el: import('../../node_modules/vue').Ref<ComponentPublicInstance<HTMLElement> | null>;
+    hasColumnHighlights: import('../../node_modules/vue').ComputedRef<boolean>;
+    hasHighlights: import('../../node_modules/vue').ComputedRef<boolean>;
+    height: import('../../node_modules/vue').Ref<number>;
+    loadedData: any;
+    paddedStyle: import('../../node_modules/vue').ComputedRef<{
+        marginLeft: string | number;
+    }>;
+    sortedData: import('../../node_modules/vue').ComputedRef<any>;
+    width: import('../../node_modules/vue').Ref<number>;
+    barTitle: (i: string | number, key: string) => any;
+    barStyle: (i: string | number, key: string) => {
+        maxWidth: string;
+        height: string;
+        backgroundColor: unknown;
+    };
+    delayHighlight: (key: string) => void;
+    formatXDatum: (d: string) => any;
+    formatYDatum: (d: string) => any;
+    groupName: (key: string) => {};
+    hasValueHidden: (i: string | number, key: string) => any;
+    hasValueOverflow: (i: string | number, key: string) => any;
+    hasValuePushed: (i: string | number, key: string) => any;
+    isColumnHighlighted: (i: string | number) => boolean;
+    isHidden: (i: string | number, key: string) => boolean;
+    isHighlighted: (key: string) => boolean;
+    restoreHighlights: () => void;
+}, 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;
+    };
+    /**
+     * Field of each object containing data (for each group)
+     */
+    keys: {
+        type: ArrayConstructor;
+        default: () => never[];
+    };
+    /**
+     * Group name to display in the legend
+     */
+    groups: {
+        type: ArrayConstructor;
+        default: () => never[];
+    };
+    /**
+     * Colors of each bar group
+     */
+    barColors: {
+        type: ArrayConstructor;
+        default: () => never[];
+    };
+    /**
+     * Max with of each bar.
+     */
+    barMaxWidth: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Hide bars that have no values.
+     */
+    hideEmptyValues: {
+        type: BooleanConstructor;
+    };
+    /**
+     * Hide the legend.
+     */
+    hideLegend: {
+        type: BooleanConstructor;
+    };
+    /**
+     * Enforce the height of the chart (regardless of the width or number of row)
+     */
+    fixedHeight: {
+        type: NumberConstructor;
+        default: null;
+    };
+    /**
+     * Function to apply to format x axis ticks
+     */
+    xAxisTickFormat: {
+        type: (StringConstructor | FunctionConstructor)[];
+        default: () => {
+            <T>(value: T): T;
+            (): undefined;
+        };
+    };
+    /**
+     * Function to apply to format y axis ticks (bars value). It can be a
+     * function returning the formatted value or a d3's formatter string.
+     */
+    yAxisTickFormat: {
+        type: (StringConstructor | FunctionConstructor)[];
+        default: () => {
+            <T>(value: T): T;
+            (): undefined;
+        };
+    };
+    /**
+     * Padding on y axis ticks
+     */
+    yAxisTickPadding: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Field containing the label for each column
+     */
+    labelField: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Sort groups by one or several keys.
+     */
+    sortBy: {
+        type: (StringConstructor | ArrayConstructor)[];
+        default: null;
+    };
+    /**
+     * Column height is relative to each group's total
+     */
+    relative: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * A list of highlighted groups
+     */
+    highlights: {
+        type: ArrayConstructor;
+        default: () => never[];
+    };
+    /**
+     * Delay to apply when set the first highlight
+     */
+    highlightDelay: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * A list of entire column to highlight
+     */
+    columnHighlights: {
+        type: ArrayConstructor;
+        default: () => never[];
+    };
+    /**
+     * Delay to apply when restoring highlights to initial state
+     */
+    restoreHighlightDelay: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * Deactivate direct labeling on bars
+     */
+    noDirectLabeling: {
+        type: BooleanConstructor;
+    };
+    /**
+     * Set max value instead of extracting it from the data.
+     */
+    maxValue: {
+        type: NumberConstructor;
+        default: null;
+    };
+    /**
+      * Function to define tooltip content.
+     */
+    tooltipDisplay: {
+        type: FunctionConstructor;
+        default: ({ formattedKey, formattedValue }: {
+            formattedKey: string;
+            formattedValue: string;
+        }) => string;
+    };
+    /**
+     * Hide bar tooltips
+     */
+    noTooltips: {
+        type: BooleanConstructor;
+    };
+}>>, {
+    keys: unknown[];
+    data: string | Record<string, any> | unknown[];
+    relative: boolean;
+    sortBy: string | unknown[];
+    xAxisTickFormat: string | Function;
+    dataUrlType: string;
+    socialMode: boolean;
+    socialModeRatio: number;
+    fixedHeight: number;
+    yAxisTickFormat: string | Function;
+    maxValue: number;
+    noTooltips: boolean;
+    highlights: unknown[];
+    barColors: unknown[];
+    groups: unknown[];
+    hideEmptyValues: boolean;
+    hideLegend: boolean;
+    highlightDelay: number;
+    labelField: string;
+    restoreHighlightDelay: number;
+    barMaxWidth: string;
+    yAxisTickPadding: number;
+    columnHighlights: unknown[];
+    noDirectLabeling: boolean;
+    tooltipDisplay: Function;
+}, {}>;
+export default _default;

package/dist/lib/enums.d.ts

@@ -0,0 +1,32 @@
+export declare enum BrandMode {
+    Short = "short",
+    Medium = "medium",
+    Long = "long"
+}
+export declare enum TooltipPlacement {
+    Top = "top",
+    Topleft = "topleft",
+    Topright = "topright",
+    Right = "right",
+    Righttop = "righttop",
+    Rightbottom = "rightbottom",
+    Bottom = "bottom",
+    Bottomleft = "bottomleft",
+    Bottomright = "bottomright",
+    Left = "left",
+    Lefttop = "lefttop",
+    Leftbottom = "leftbottom"
+}
+export declare enum DeckTexture {
+    Silk = "silk",
+    Brick = "brick",
+    Rock = "rock",
+    Sand = "sand",
+    Crack = "crack",
+    Carbon = "carbon"
+}
+export declare enum Size {
+    sm = "sm",
+    md = "md",
+    lg = "lg"
+}

package/dist/lib/i18n.d.ts

@@ -0,0 +1,4 @@
+import { I18n } from 'vue-i18n';
+export declare const locale: string;
+export declare const fallbackLocale: string;
+export declare const i18n: I18n;

package/dist/lib/keys.d.ts

@@ -0,0 +1,2 @@
+export declare const AccordionKey: unique symbol;
+export declare const ParentKey: unique symbol;

package/dist/lib/main.d.ts

@@ -0,0 +1,52 @@
+/// <reference types="@/shims-vue" />
+/// <reference types="node_modules/vue-i18n/dist/vue-i18n" />
+import * as components from './components';
+import { type App } from '../node_modules/vue';
+export { default as AccordionWrapper } from './components/AccordionWrapper.vue';
+export { default as AccordionStep } from './components/AccordionStep.vue';
+export { default as ActiveTextTruncate } from './components/ActiveTextTruncate.vue';
+export { default as AdvancedLinkForm } from './components/AdvancedLinkForm.vue';
+export { default as Brand } from './components/Brand.vue';
+export { default as BrandExpansion } from './components/BrandExpansion.vue';
+export { default as ConfirmButton } from './components/ConfirmButton.vue';
+export { default as ContentPlaceholder } from './components/ContentPlaceholder.vue';
+export { default as CustomPagination } from './components/CustomPagination.vue';
+export { default as DigitsInput } from './components/DigitsInput.vue';
+export { default as DonateForm } from './components/DonateForm.vue';
+export { default as EmbeddableFooter } from './components/EmbeddableFooter.vue';
+export { default as EmbedForm } from './components/EmbedForm.vue';
+export { default as Fa } from './components/Fa';
+export { default as FollowUsPopover } from './components/FollowUsPopover.vue';
+export { default as GenericFooter } from './components/GenericFooter.vue';
+export { default as GenericHeader } from './components/GenericHeader.vue';
+export { default as HapticCopy } from './components/HapticCopy.vue';
+export { default as ImddbHeader } from './components/ImddbHeader.vue';
+export { default as OrdinalLegend } from './components/OrdinalLegend.vue';
+export { default as RangePicker } from './components/RangePicker.vue';
+export { default as ResponsiveIframe } from './components/ResponsiveIframe.vue';
+export { default as ScaleLegend } from './components/ScaleLegend.vue';
+export { default as SecretInput } from './components/SecretInput.vue';
+export { default as SelectableDropdown } from './components/SelectableDropdown.vue';
+export { default as SharingOptions } from './components/SharingOptions.vue';
+export { default as SharingOptionsLink } from './components/SharingOptionsLink.vue';
+export { default as SignUpForm } from './components/SignUpForm.vue';
+export { default as SlideUpDown } from './components/SlideUpDown.vue';
+export { default as TexturedDeck } from './components/TexturedDeck.vue';
+export { default as TinyPagination } from './components/TinyPagination.vue';
+export { default as BarChart } from './datavisualisations/BarChart.vue';
+export { default as ColumnChart } from './datavisualisations/ColumnChart.vue';
+export { default as LineChart } from './datavisualisations/LineChart.vue';
+export { default as StackedBarChart } from './datavisualisations/StackedBarChart.vue';
+export { default as ChoroplethMap } from './maps/ChoroplethMap.vue';
+export { default as SymbolMap } from './maps/SymbolMap.vue';
+declare const Murmur: {
+    readonly i18n: import("vue-i18n").I18n<{}, {}, {}, string, boolean>;
+    readonly config: import("./config").Config;
+    readonly components: typeof components;
+    setLocaleMessage(lang: string, message: any): void;
+    mergeLocaleMessage(lang: string, message: any): void;
+    setLocale(lang: "fr" | "en"): "en" | "fr";
+    getLocale(): any;
+    install(app: App<Element>): void;
+};
+export default Murmur;