analytica-frontend-lib/dist/ChoroplethMap/ChoroplethMap.types/index.d.ts

Repositório público dos componentes utilizados nas plataformas da Analytica Ensino

import type { ReactNode } from 'react';
import type { Feature, MultiPolygon, Polygon } from 'geojson';
/**
 * With/without-access counts for a single profile group in a region.
 */
export interface AccessBreakdownEntry {
    /** Users of this profile that accessed in the period */
    withAccess: number;
    /** Users of this profile that did NOT access in the period */
    withoutAccess: number;
}
/**
 * Per-profile access breakdown shown in the region tooltip. Always covers the
 * three profile groups (students, teachers, managers), independent of any map
 * filter.
 */
export interface AccessBreakdown {
    students: AccessBreakdownEntry;
    teachers: AccessBreakdownEntry;
    managers: AccessBreakdownEntry;
}
/**
 * Region data interface for choropleth map
 */
export interface RegionData {
    /** Unique identifier for the region (per-city) */
    id: string;
    /** Display name of the region — the municipality (city) name */
    name: string;
    /**
     * Grouping label used only to draw the NRE outline that visually groups the
     * cities of the same NRE. When omitted, the region's own `name` is used as the
     * group (each region is its own group). Coloring, tooltip, hover and zoom are
     * per-city (keyed on `id`/`name`), independent of this field.
     */
    groupName?: string;
    /** Code identifier for the region */
    code?: string | null;
    /** Normalized value between 0 and 1 for color classification */
    value: number;
    /** Raw access count for the region */
    accessCount: number;
    /** GeoJSON feature for the region polygon */
    geoJson: Feature<MultiPolygon | Polygon>;
    /**
     * Whether the region is managed by the logged user. When false, the region
     * is rendered with the unmanaged gray fill, shows a name-only tooltip and
     * does not trigger onRegionClick. Undefined is treated as true.
     */
    isManagedRegion?: boolean;
    /**
     * Optional per-profile access breakdown for the tooltip. When present, the
     * tooltip shows the three profile lines (students/teachers/managers) instead
     * of the single `countLabel` count.
     */
    accessBreakdown?: AccessBreakdown;
}
/**
 * Legend item interface for choropleth map
 */
export interface LegendItem {
    /** Display label for the legend item */
    label: string;
    /** Fill color for the legend item */
    color: string;
    /** Optional border color for the legend item */
    borderColor?: string;
}
/**
 * Map bounds interface
 */
export interface MapBounds {
    north: number;
    south: number;
    east: number;
    west: number;
}
/**
 * Props interface for ChoroplethMap component
 */
export interface ChoroplethMapProps {
    /** Array of region data to display on the map. Should be memoized to avoid unnecessary re-renders. */
    data: RegionData[];
    /** Google Maps API key */
    apiKey: string;
    /** Optional title for the map section */
    title?: string;
    /** Label shown before the count value in the region tooltip (default: 'Acessos') */
    countLabel?: string;
    /** Loading state indicator */
    loading?: boolean;
    /** Map bounds for initial view */
    bounds?: MapBounds;
    /** Callback when a region is clicked */
    onRegionClick?: (region: RegionData) => void;
    /**
     * Optional action rendered on the right side of the header (e.g. a device
     * filter select).
     */
    headerAction?: ReactNode;
    /**
     * Optional informational text rendered in an info Alert below the map,
     * inside the map card.
     */
    infoText?: string;
    /**
     * When set, the region tooltip shows only the given profile's access line
     * instead of all three. Omit to show every profile (default; used by the
     * schools map, which aggregates all three profile groups).
     */
    activeProfile?: keyof AccessBreakdown;
    /** Optional additional CSS classes */
    className?: string;
}
/**
 * Color class configuration for choropleth map
 */
export interface ColorClass {
    /** Minimum threshold value (inclusive) */
    min: number;
    /** Maximum threshold value (exclusive) */
    max: number;
    /** Fill color for regions in this class */
    fillColor: string;
    /** Stroke color for regions in this class */
    strokeColor: string;
    /** Label for the legend */
    label: string;
}
//# sourceMappingURL=ChoroplethMap.types.d.ts.map