@undp/data-viz 2.5.4 → 2.6.1

package/dist/BiVariateChoroplethMap.d.ts

@@ -1,221 +1,2 @@
-import { FeatureCollection } from 'geojson';
-import { JSX } from 'react/jsx-runtime';
-
-declare interface AnimateDataType {
-    duration: number;
-    once: boolean;
-    amount: 'some' | 'all' | number;
-}
-
-declare interface AxesClassNameObject {
-    gridLines?: string;
-    labels?: string;
-    title?: string;
-    axis?: string;
-}
-
-declare interface AxesStyleObject {
-    gridLines?: React.CSSProperties;
-    labels?: React.CSSProperties;
-    title?: React.CSSProperties;
-    axis?: React.CSSProperties;
-}
-
-export declare function BiVariateChoroplethMap(props: Props): JSX.Element | null;
-
-declare interface BivariateMapDataType {
-    x?: number | null;
-    y?: number | null;
-    id: string;
-    date?: string | number;
-    data?: object;
-}
-
-declare interface ClassNameObject {
-    title?: string;
-    footnote?: string;
-    source?: string;
-    description?: string;
-    tooltip?: string;
-    xAxis?: AxesClassNameObject;
-    yAxis?: AxesClassNameObject;
-    legend?: string;
-    graphContainer?: string;
-    graphObjectValues?: string;
-    dataConnectors?: string;
-    mouseOverLine?: string;
-    regLine?: string;
-    dataCards?: string;
-    colorLegend?: string;
-    modal?: string;
-}
-
-declare interface CustomLayerDataType {
-    position: 'before' | 'after';
-    layer: React.ReactNode;
-}
-
-declare type Languages = 'en' | 'ar' | 'az' | 'bn' | 'cy' | 'he' | 'hi' | 'ja' | 'ka' | 'km' | 'ko' | 'my' | 'ne' | 'zh' | 'custom';
-
-declare interface MapOverlayDataType {
-    mapData: FeatureCollection | string;
-    mapBorderWidth?: number;
-    mapBorderColor?: string;
-}
-
-declare type MapProjectionTypes = 'mercator' | 'equalEarth' | 'naturalEarth' | 'orthographic' | 'albersUSA';
-
-declare interface NumberFormatOptions {
-    locale?: string;
-    precision?: number;
-    prefix?: string;
-    suffix?: string;
-    padZeros?: boolean;
-}
-
-declare interface Props {
-    /** Array of data objects. */
-    data: BivariateMapDataType[];
-    /** Title of the graph */
-    graphTitle?: string | React.ReactNode;
-    /** Description of the graph */
-    graphDescription?: string | React.ReactNode;
-    /** Footnote for the graph */
-    footNote?: string | React.ReactNode;
-    /** Source data for the graph */
-    sources?: SourcesDataType[];
-    /** Accessibility label */
-    ariaLabel?: string;
-    /** Colors for the choropleth map. Array must be 5x5 */
-    colors?: string[][];
-    /** Title for the first color legend */
-    xColorLegendTitle?: string;
-    /** Title for the second color legend */
-    yColorLegendTitle?: string;
-    /** Domain of x-colors for the map */
-    xDomain?: number[];
-    /** Domain of y-colors for the map */
-    yDomain?: number[];
-    /** Color for the areas where data is no available */
-    mapNoDataColor?: string;
-    /** Background color of the graph */
-    backgroundColor?: string | boolean;
-    /** Custom styles for the graph. Each object should be a valid React CSS style object. */
-    styles?: StyleObject;
-    /** Custom class names */
-    classNames?: ClassNameObject;
-    /** Width of the graph */
-    width?: number;
-    /** Height of the graph */
-    height?: number;
-    /** Minimum height of the graph */
-    minHeight?: number;
-    /** Relative height scaling factor. This overwrites the height props */
-    relativeHeight?: number;
-    /** Padding around the graph. Defaults to 0 if no backgroundColor is mentioned else defaults to 1rem */
-    padding?: string;
-    /** Map data as an object in geoJson format or a url for geoJson */
-    mapData?: FeatureCollection | string;
-    /** Detail if any other map needs to be overlayed over the main map */
-    mapOverlay?: MapOverlayDataType;
-    /** Defines if the coordinates in the map data should be rewinded or not. Try to change this is the visualization shows countries as holes instead of shapes. */
-    rewindCoordinatesInMapData?: boolean;
-    /** Scaling factor for the map. Multiplies the scale number to scale. */
-    scale?: number;
-    /** Center point of the map */
-    centerPoint?: [number, number];
-    /** Controls the rotation of the map projection, in degrees, applied before rendering. Useful for shifting the antimeridian to focus the map on different regions */
-    projectionRotate?: [number, number] | [number, number, number];
-    /** Defines the zoom mode for the map */
-    zoomInteraction?: ZoomInteractionTypes;
-    /** Stroke width of the regions in the map */
-    mapBorderWidth?: number;
-    /** Stroke color of the regions in the map */
-    mapBorderColor?: string;
-    /** Toggle if the map is a world map */
-    isWorldMap?: boolean;
-    /** Map projection type */
-    mapProjection?: MapProjectionTypes;
-    /** Toggle if the map is centered and zoomed to the highlighted ids. */
-    zoomAndCenterByHighlightedIds?: boolean;
-    /** Extend of the allowed zoom in the map */
-    zoomScaleExtend?: [number, number];
-    /** Extend of the allowed panning in the map */
-    zoomTranslateExtend?: [[number, number], [number, number]];
-    /** Countries or regions to be highlighted */
-    highlightedIds?: string[];
-    /** Defines the opacity of the non-highlighted data */
-    dimmedOpacity?: number;
-    /** Toggles if the graph animates in when loaded.  */
-    animate?: boolean | AnimateDataType;
-    /** Property in the property object in mapData geoJson object is used to match to the id in the data object */
-    mapProperty?: string;
-    /** Toggle visibility of color scale. */
-    showColorScale?: boolean;
-    /** Toggle if color scale is collapsed by default. */
-    collapseColorScaleByDefault?: boolean;
-    /** Toggles the visibility of Antarctica in the default map. Only applicable for the default map. */
-    showAntarctica?: boolean;
-    /** Optional SVG <g> element or function that renders custom content behind or in front of the graph. */
-    customLayers?: CustomLayerDataType[];
-    /** Configures playback and slider controls for animating the chart over time. The data must have a key date for it to work properly. */
-    timeline?: TimelineDataType;
-    /** Configuration options for controlling number formatting, localization, precision, and zero padding. */
-    xNumberDisplayOptions?: Omit<NumberFormatOptions, 'suffix' | 'prefix'>;
-    /** Configuration options for controlling number formatting, localization, precision, and zero padding. */
-    yNumberDisplayOptions?: Omit<NumberFormatOptions, 'suffix' | 'prefix'>;
-    /** Enable graph download option as png */
-    graphDownload?: boolean;
-    /** Enable data download option as a csv */
-    dataDownload?: boolean;
-    /** Reset selection on double-click. Only applicable when used in a dashboard context with filters. */
-    resetSelectionOnDoubleClick?: boolean;
-    /** Tooltip content. If the type is string then this uses the [handlebar](../?path=/docs/misc-handlebars-templates-and-custom-helpers--docs) template to display the data */
-    tooltip?: string | ((_d: any) => React.ReactNode);
-    /** Details displayed on the modal when user clicks of a data point. If the type is string then this uses the [handlebar](../?path=/docs/misc-handlebars-templates-and-custom-helpers--docs) template to display the data */
-    detailsOnClick?: string | ((_d: any) => React.ReactNode);
-    /** Callback for mouse over event */
-    onSeriesMouseOver?: (_d: any) => void;
-    /** Callback for mouse click event */
-    onSeriesMouseClick?: (_d: any) => void;
-    /** Language setting  */
-    language?: Languages;
-    /** Color theme */
-    theme?: 'light' | 'dark';
-    /** Unique ID for the graph */
-    graphID?: string;
-}
-
-declare interface SourcesDataType {
-    source: string;
-    link?: string;
-}
-
-declare interface StyleObject {
-    title?: React.CSSProperties;
-    footnote?: React.CSSProperties;
-    source?: React.CSSProperties;
-    description?: React.CSSProperties;
-    graphContainer?: React.CSSProperties;
-    tooltip?: React.CSSProperties;
-    xAxis?: AxesStyleObject;
-    yAxis?: AxesStyleObject;
-    graphObjectValues?: React.CSSProperties;
-    dataConnectors?: React.CSSProperties;
-    mouseOverLine?: React.CSSProperties;
-    regLine?: React.CSSProperties;
-    dataCards?: React.CSSProperties;
-    modal?: React.CSSProperties;
-}
-
-declare interface TimelineDataType {
-    autoplay: boolean;
-    enabled: boolean;
-    showOnlyActiveDate: boolean;
-    speed?: number;
-    dateFormat?: string;
-}
-
-declare type ZoomInteractionTypes = 'scroll' | 'ctrlScroll' | 'button' | 'noZoom';
-
-export { }
+export * from './Components/Graphs/Maps/BiVariateMap/index'
+export {}