@icij/murmur-next 4.7.0 → 4.7.2

package/dist/lib/types/maps.d.ts

@@ -1,309 +0,0 @@
-import { ComputedRef, Ref } from '../../node_modules/vue';
-import { GeoProjection } from 'd3-geo';
-import { PopoverPlacement } from 'bootstrap-vue-next';
-import { ParentKey } from '../keys';
-import { PLACEMENTS } from '../enums';
-export interface MapTransform {
-    k: number;
-    x: number;
-    y: number;
-    rotateX: number;
-    rotateY: number;
-}
-export interface ParentMap {
-    mapRect: Ref<DOMRect>;
-    mapTransform: Ref<MapTransform>;
-    rotatingMapProjection: ComputedRef<GeoProjection | (() => number[])>;
-}
-export interface ParentMapProvide {
-    [ParentKey]: ParentMap;
-}
-/**
- * ChoroplethMap component props
- */
-export interface ChoroplethMapProps {
-    /**
-     * Covers the empty values with a hatched pattern.
-     */
-    hatchEmpty?: boolean;
-    /**
-     * Hide the legend of the map.
-     */
-    hideLegend?: boolean;
-    /**
-     * Change the scale function used to get calculate a feature color.
-     */
-    featureColorScale?: ((v: any) => string) | null;
-    /**
-     * Change the color of the outline.
-     */
-    outlineColor?: string;
-    /**
-     * Change the color of the graticule.
-     */
-    graticuleColor?: string;
-    /**
-     * Maximum value to use in the color scale.
-     */
-    max?: number | null;
-    /**
-     * Minimum value to use in the color scale.
-     */
-    min?: number | null;
-    /**
-     * If true the map should be clickable (and zoom on a given feature).
-     */
-    clickable?: boolean;
-    /**
-     * Field in the topojson containing all the feature objects.
-     */
-    topojsonObjects?: string;
-    /**
-     * Field in the topojson objects containing the id of a feature. This field supports dot notation for nested values.
-     */
-    topojsonObjectsPath?: string | string[];
-    /**
-     * URL of the topojson.
-     */
-    topojsonUrl?: string;
-    /**
-     * Duration of the transitions.
-     */
-    transitionDuration?: number;
-    /**
-     * If true the user will be able to navigate in the map with drag and mouse wheel.
-     */
-    zoomable?: boolean;
-    /**
-     * Set to true if your projection is spherical.
-     */
-    spherical?: boolean;
-    /**
-     * Minimum zoom value.
-     */
-    zoomMin?: number;
-    /**
-     * Maximum zoom value.
-     */
-    zoomMax?: number;
-    /**
-     * Initial zoom value.
-     */
-    zoom?: number | null;
-    /**
-     * Initial center of the map.
-     */
-    center?: number[] | null;
-    /**
-     * Projection object from d3 to draw the features.
-     * @see https://d3js.org/d3-geo/projection
-     */
-    projection?: () => GeoProjection;
-    /**
-     * If true the map will display a sphere outline around the world.
-     */
-    outline?: boolean;
-    /**
-     * If true the map will display a graticule grid (representing parallels and meridians).
-     */
-    graticule?: boolean;
-    /**
-     * Maximum height used by the map.
-     */
-    height?: string;
-    /**
-     * Neutral color of the map's features.
-     */
-    color?: string;
-    /**
-     * Neutral color of the map s features in social mode.
-     */
-    socialColor?: string;
-    /**
-     * Data to display, either as a URL string to fetch or an object.
-     */
-    data?: string | object[] | Record<string, number> | null;
-    /**
-     * Type of data file when fetching from URL.
-     */
-    dataUrlType?: 'json' | 'csv' | 'tsv';
-    /**
-     * Aspect ratio (height/width) for the chart.
-     */
-    chartHeightRatio?: number;
-    /**
-     * Enable social mode for optimal display when sharing on social media.
-     */
-    socialMode?: boolean;
-    /**
-     * Aspect ratio to use in social mode.
-     */
-    socialModeRatio?: number;
-}
-/**
- * ChoroplethMapAnnotation component props
- */
-export interface ChoroplethMapAnnotationProps {
-    /**
-     * Latitude of the annotation.
-     */
-    latitude: number;
-    /**
-     * Longitude of the annotation.
-     */
-    longitude: number;
-    /**
-     * Maximum height of the annotation container.
-     */
-    height?: number;
-    /**
-     * Maximum width of the annotation container.
-     */
-    width?: number;
-    /**
-     * If true, the annotation will scale with the map zoom.
-     */
-    scale?: boolean;
-    /**
-     * Text color of the annotation.
-     */
-    color?: string;
-    /**
-     * Override the default drop-shadow filter applied to the annotation.
-     */
-    dropShadow?: string;
-    /**
-     * Radian distance from the center of the Earth after which the annotation is hidden.
-     * The Earth's circumference can be divided into 360 degrees, or 2π radians.
-     * Therefore, 1.57 radians is approximately a quarter of π (since π≈3.14), which corresponds to
-     * a quarter of the Earth's circumference.
-     */
-    geoDistanceThreshold?: number;
-    /**
-     * Placement of the annotation. Can be: top, topleft, topright, right,
-     * righttop, rightbottom, bottom, bottomleft, bottomright, left, lefttop,
-     * and leftbottom. If `null`, the annotation will be centered.
-     */
-    placement?: PLACEMENTS | null;
-}
-/**
- * SymbolMap component props
- */
-export interface SymbolMapProps {
-    /**
-     * Path in data objects to the category value for grouping markers.
-     */
-    categoryObjectsPath?: string | string[];
-    /**
-     * Enable click-to-zoom on map features.
-     */
-    clickable?: boolean;
-    /**
-     * Hide the legend.
-     */
-    hideLegend?: boolean;
-    /**
-     * Hide tooltips on marker hover.
-     */
-    hideTooltip?: boolean;
-    /**
-     * Display legend items horizontally instead of vertically.
-     */
-    horizontalLegend?: boolean;
-    /**
-     * Color for map features, or function returning color based on feature data.
-     */
-    featureColor?: string | ((d: any) => string);
-    /**
-     * Fit map projection to marker bounds instead of feature bounds.
-     */
-    fitToMarkers?: boolean;
-    /**
-     * Path in data objects to the label value for tooltips.
-     */
-    labelObjectsPath?: string | string[];
-    /**
-     * Padding around the map in pixels.
-     */
-    mapPadding?: number;
-    /**
-     * Path in data objects to the unique identifier for each marker.
-     */
-    markerObjectsPath?: string | string[];
-    /**
-     * SVG path data for marker shape, or function returning path based on marker data.
-     */
-    markerPath?: string | ((d: any) => string);
-    /**
-     * Color for markers. Falls back to category colors if not set.
-     */
-    markerColor?: string | null;
-    /**
-     * Width of markers in pixels, or function returning width based on marker data.
-     */
-    markerWidth?: number | ((d: any) => number);
-    /**
-     * Disable marker scaling when zooming the map.
-     */
-    noMarkersScale?: boolean;
-    /**
-     * Custom CSS class to apply to tooltips.
-     */
-    tooltipCustomClass?: string | null;
-    /**
-     * Placement of tooltips relative to markers.
-     */
-    tooltipPlacement?: PopoverPlacement;
-    /**
-     * Fallback placement(s) for tooltips when preferred placement is not available.
-     */
-    tooltipFallbackPlacement?: string[] | string;
-    /**
-     * Name of the TopoJSON objects collection to render as map features.
-     */
-    topojsonObjects?: string;
-    /**
-     * Path in TopoJSON feature properties to the identifier.
-     */
-    topojsonObjectsPath?: string | string[];
-    /**
-     * URL to fetch TopoJSON data from.
-     */
-    topojsonUrl?: string;
-    /**
-     * Duration of zoom transitions in milliseconds.
-     */
-    transitionDuration?: number;
-    /**
-     * Enable zoom and pan interactions on the map.
-     */
-    zoomable?: boolean;
-    /**
-     * Minimum zoom level.
-     */
-    zoomMin?: number;
-    /**
-     * Maximum zoom level.
-     */
-    zoomMax?: number;
-    /**
-     * Data to display, either as a URL string to fetch or an array of objects.
-     */
-    data?: string | object[] | null;
-    /**
-     * Type of data file when fetching from URL.
-     */
-    dataUrlType?: 'json' | 'csv' | 'tsv';
-    /**
-     * Aspect ratio (height/width) for the chart.
-     */
-    chartHeightRatio?: number;
-    /**
-     * Enable social mode for optimal display when sharing on social media.
-     */
-    socialMode?: boolean;
-    /**
-     * Aspect ratio to use in social mode.
-     */
-    socialModeRatio?: number;
-}

package/lib/types/datavisualisations.ts

@@ -1,375 +0,0 @@
-/**
- * Datavisualisation component prop types
- */
-
-/**
- * Common chart props shared by all chart components
- */
-export interface BaseChartProps {
-  /**
-   * Data to display, either as a URL string to fetch or an array of objects.
-   */
-  data?: string | object[] | null
-  /**
-   * Type of data file when fetching from URL.
-   */
-  dataUrlType?: 'json' | 'csv' | 'tsv'
-  /**
-   * Aspect ratio (height/width) for the chart.
-   */
-  chartHeightRatio?: number
-  /**
-   * Enable social mode for optimal display when sharing on social media.
-   */
-  socialMode?: boolean
-  /**
-   * Aspect ratio to use in social mode.
-   */
-  socialModeRatio?: number
-}
-
-/**
- * BarChart component props
- */
-export interface BarChartProps extends BaseChartProps {
-  /**
-   * Height of each bar in pixels.
-   */
-  barHeight?: number
-  /**
-   * Vertical gap between bars in pixels.
-   */
-  barGap?: number
-  /**
-   * Color of the bars. Falls back to theme's dark color.
-   */
-  barColor?: string | null
-  /**
-   * Color of highlighted bars. Falls back to theme's primary color.
-   */
-  barHighlightColor?: string | null
-  /**
-   * Fixed width for labels in pixels. If not set, width is calculated automatically.
-   */
-  fixedLabelWidth?: number | null
-  /**
-   * Fixed width for values in pixels. If not set, width is calculated automatically.
-   */
-  fixedValueWidth?: number | null
-  /**
-   * Horizontal gap between labels and bars in pixels.
-   */
-  labelGap?: number
-  /**
-   * Horizontal gap between bars and their values in pixels.
-   */
-  valueGap?: number
-  /**
-   * Field name(s) to sort the data by.
-   */
-  sortBy?: string | string[] | null
-  /**
-   * Formatter function or d3 format string for x-axis tick values.
-   */
-  xAxisTickFormat?: ((v: number | string) => string) | string
-}
-
-/**
- * ColumnChart component props
- */
-export interface ColumnChartProps extends BaseChartProps {
-  /**
-   * Color of the columns. Falls back to theme's dark color.
-   */
-  columnColor?: string | null
-  /**
-   * Color of highlighted columns. Falls back to theme's primary color.
-   */
-  columnHighlightColor?: string | null
-  /**
-   * Fixed height for the chart in pixels. If not set, height is calculated from width.
-   */
-  fixedHeight?: number | null
-  /**
-   * Fixed width for y-axis labels in pixels. If not set, width is calculated automatically.
-   */
-  fixedLabelWidth?: number | null
-  /**
-   * Field name in data objects containing the value to display.
-   */
-  seriesName?: string
-  /**
-   * Collapse x-axis ticks to prevent overlapping when there are many data points.
-   */
-  xAxisTickCollapse?: boolean
-  /**
-   * Formatter function or d3 format string for x-axis tick labels.
-   */
-  xAxisTickFormat?: ((v: number | string) => string) | string
-  /**
-   * Explicit list of x-axis tick values to display.
-   */
-  xAxisTicks?: string[] | null
-  /**
-   * Formatter function or d3 format string for y-axis tick labels.
-   */
-  yAxisTickFormat?: ((v: number | string) => string) | string
-  /**
-   * Number of y-axis ticks or d3 tick configuration object.
-   */
-  yAxisTicks?: number | object
-  /**
-   * Field name(s) to sort the data by.
-   */
-  sortBy?: string | string[] | null
-  /**
-   * Field name in data objects containing the x-axis category/time value.
-   */
-  timeseriesKey?: string
-  /**
-   * Maximum value for the y-axis scale. If not set, derived from data.
-   */
-  maxValue?: number | null
-  /**
-   * Disable tooltips on column hover.
-   */
-  noTooltips?: boolean
-  /**
-   * Hide the x-axis.
-   */
-  noXAxis?: boolean
-  /**
-   * Hide the y-axis.
-   */
-  noYAxis?: boolean
-  /**
-   * Padding between columns as a ratio (0-1) of the column width.
-   */
-  barPadding?: number
-  /**
-   * Margin between columns in pixels.
-   */
-  barMargin?: number
-  /**
-   * List of timeseriesKey values to highlight.
-   */
-  highlights?: string[]
-  /**
-   * Show placeholder bars for visual pattern.
-   */
-  stripped?: boolean
-  /**
-   * Enable hover effects on columns.
-   */
-  hover?: boolean
-  /**
-   * Icon component to display on column hover.
-   */
-  hoverIcon?: string | object | object[] | null
-  /**
-   * Size of the hover icon.
-   */
-  hoverIconSize?: string
-}
-
-/**
- * LineChart component props
- */
-export interface LineChartProps extends BaseChartProps {
-  /**
-   * Color of the line. Falls back to theme's dark color.
-   */
-  lineColor?: string | null
-  /**
-   * Fixed width for y-axis labels in pixels. If not set, width is calculated automatically.
-   */
-  fixedLabelWidth?: number | null
-  /**
-   * Fixed height for the chart in pixels. If not set, height is calculated from width.
-   */
-  fixedHeight?: number | null
-  /**
-   * Field name in data objects containing the y-axis value.
-   */
-  seriesName?: string
-  /**
-   * Number of x-axis ticks or d3 tick configuration.
-   */
-  xAxisTicks?: object | number | ((d: Date) => string) | null
-  /**
-   * Formatter function or d3 format string for y-axis tick labels.
-   */
-  yAxisTickFormat?: ((v: number | string) => string) | string
-  /**
-   * Number of y-axis ticks or d3 tick configuration.
-   */
-  yAxisTicks?: object | number
-  /**
-   * Field name in data objects containing the x-axis time/date value (parsed as year).
-   */
-  timeseriesKey?: string
-}
-
-/**
- * StackedBarChart component props
- */
-export interface StackedBarChartProps extends BaseChartProps {
-  /**
-   * Colors for each bar segment/key.
-   */
-  barColors?: string[]
-  /**
-   * Fixed height for the chart in pixels. If not set, height is calculated automatically.
-   */
-  fixedHeight?: number | null
-  /**
-   * Display names for each key in the legend.
-   */
-  groups?: string[]
-  /**
-   * Hide bar segments that have no values.
-   */
-  hideEmptyValues?: boolean
-  /**
-   * Hide the legend.
-   */
-  hideLegend?: boolean
-  /**
-   * List of keys to highlight initially.
-   */
-  highlights?: string[]
-  /**
-   * Delay in milliseconds before highlighting a key on hover.
-   */
-  highlightDelay?: number
-  /**
-   * Field names in data objects containing values for each stacked segment.
-   */
-  keys?: string[]
-  /**
-   * Position labels above the bars instead of to the left.
-   */
-  labelAbove?: boolean
-  /**
-   * Field name in data objects containing the row label.
-   */
-  labelField?: string
-  /**
-   * Minimum height for each bar row in pixels.
-   */
-  minBarHeight?: number
-  /**
-   * Maximum height for each bar row in pixels.
-   */
-  maxBarHeight?: number
-  /**
-   * Calculate bar widths relative to each row's total instead of the global maximum.
-   */
-  relative?: boolean
-  /**
-   * Delay in milliseconds before restoring highlights to initial state.
-   */
-  restoreHighlightDelay?: number
-  /**
-   * List of row labels to highlight.
-   */
-  rowHighlights?: string[]
-  /**
-   * Field name(s) to sort the data by.
-   */
-  sortBy?: string | string[] | null
-  /**
-   * Formatter function or d3 format string for bar values.
-   */
-  xAxisTickFormat?: ((v: number | string) => string) | string
-}
-
-/**
- * StackedColumnChart component props
- */
-export interface StackedColumnChartProps extends BaseChartProps {
-  /**
-   * Field of each object containing data (for each group)
-   */
-  keys?: string[]
-  /**
-   * Group name to display in the legend
-   */
-  groups?: string[]
-  /**
-   * Colors of each bar group
-   */
-  barColors?: string[]
-  /**
-   * Max with of each bar.
-   */
-  barMaxWidth?: string
-  /**
-   * Hide bars that have no values.
-   */
-  hideEmptyValues?: boolean
-  /**
-   * Hide the legend.
-   */
-  hideLegend?: boolean
-  /**
-   * Enforce the height of the chart (regardless of the width or number of row)
-   */
-  fixedHeight?: number | null
-  /**
-   * Function to apply to format x-axis ticks
-   */
-  xAxisTickFormat?: ((v: number | string) => string) | string
-  /**
-   * Function to apply to format y-axis ticks (bars value).
-   */
-  yAxisTickFormat?: ((v: number | string) => string) | string
-  /**
-   * Padding on y-axis ticks
-   */
-  yAxisTickPadding?: number
-  /**
-   * Field containing the label for each column
-   */
-  labelField?: string
-  /**
-   * Sort groups by one or several keys.
-   */
-  sortBy?: string | string[] | null
-  /**
-   * Column height is relative to each group's total
-   */
-  relative?: boolean
-  /**
-   * A list of highlighted groups
-   */
-  highlights?: string[]
-  /**
-   * Delay to apply when set the first highlight
-   */
-  highlightDelay?: number
-  /**
-   * A list of entire column to highlight
-   */
-  columnHighlights?: string[]
-  /**
-   * Delay to apply when restoring highlights to initial state
-   */
-  restoreHighlightDelay?: number
-  /**
-   * Deactivate direct labeling on bars
-   */
-  noDirectLabeling?: boolean
-  /**
-   * Set max value instead of extracting it from the data.
-   */
-  maxValue?: number | null
-  /**
-   * Function to define tooltip content.
-   */
-  tooltipDisplay?: (params: { value?: number, formattedKey: string, formattedValue: string, key?: string }) => string
-  /**
-   * Hide bar tooltips
-   */
-  noTooltips?: boolean
-}