@dra2020/dra-types 1.8.142 → 1.8.144

package/dist/colormgr.d.ts

@@ -27,11 +27,15 @@ export declare const ColorByGreatD = 6;
 export declare let PartisanDistrictStops: number[];
 export declare let PartisanPrecinctStops: number[];
 export declare let EthnicFewStops: number[];
+export declare const ColorBrewerSchemeStops: number[];
 export type PaletteDefaults = {
     [key: string]: string;
 };
 export declare const DefaultPaletteDefaults: PaletteDefaults;
 export declare function makeStops(stops: number[], colors: string[]): Util.Stop[];
+export declare function partisanStops(stops: number[], palette: PaletteName): Util.Stop[];
+export declare function partisanDistrictStops(stops: number[], palette: PaletteName): Util.Stop[];
+export declare function ethnicStops(stops: number[], palette: PaletteName): Util.Stop[];
 export declare function ethnicBackgroundColor(index: number, pd: PaletteDefaults): string;
 export declare function ToAllEthnicColor(agg: PF.PackedFields, dc: PF.DatasetContext, pd: PaletteDefaults): number;
 export declare function ToPartisanColorStr(agg: PF.PackedFields, dc: PF.DatasetContext, pd: PaletteDefaults): string;
@@ -44,9 +48,7 @@ export declare function AggregatePartisanColorStr(getter: PF.FieldGetter, stops:
 export declare function ColorFromRGBPcts(pctRed: number, pctGreen: number, pctBlue: number, stops: Util.GradientStops): string;
 export type ColorUse = 'districts' | 'partisanScale' | 'demographicsScale' | 'demographicsAllGroups' | 'partisanDistrictsScale';
 export declare const PaletteNames: readonly ["jet_r", "turbo_r", "inferno_r", "viridis_r", "magma_r", "plasma_r", "Greys", "bone_r", "draclassic", "demographicsclassic", "partisanclassic", "allgroupsclassic", "partisandistrictsclassic"];
-export type PaletteName = typeof PaletteNames[number];
-export declare function colorsFromStops(palette: PaletteName, stops: number[], classicColors: string[]): string[];
-export declare function colorsFromStopsPartisan(palette: PaletteName, colorUse: ColorUse, stops: number[]): string[];
+export type PaletteName = string;
 export declare function allGroups16Colors(palette: PaletteName, colors: string[]): string[];
 export interface DistrictCache {
     colorElection?: string;

package/dist/datasets.d.ts

@@ -90,3 +90,10 @@ export declare function datasetRestrict(ds: Dataset): {
 export type DatasetIndex = {
     [id: string]: Dataset;
 };
+export interface PrimaryKeys {
+    CENSUS: string;
+    VAP: string;
+    ELECTION: string;
+}
+export declare function defaultBuiltinKeys(state: string, datasource: string, planType: string, builtins: Set<string>): PrimaryKeys;
+export declare function usesPrisonerAdjust(state: string, datasource: string, planType: string): boolean;

package/dist/dra-types.js

@@ -120,9 +120,12 @@ Object.defineProperty(exports, "__esModule", ({ value: true }));
 
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.BinEthnicAsian = exports.BinEthnicBlack = exports.BinEthnicWhite = exports.BinBlack = exports.BinDeepPink = exports.BinMagenta = exports.BinDarkViolet = exports.BinBlueViolet = exports.BinBlue = exports.BinLightBlue = exports.BinCyan = exports.BinMediumSpringGreen = exports.BinLime = exports.BinChartreuse = exports.BinGreenish = exports.BinYellow = exports.BinGold = exports.BinOrange = exports.BinBrown = exports.BinOrangeRed = exports.BinRed = exports.PaletteNames = exports.DefaultPaletteDefaults = exports.EthnicFewStops = exports.PartisanPrecinctStops = exports.PartisanDistrictStops = exports.ColorByGreatD = exports.ColorByGoodD = exports.ColorByFairD = exports.ColorByEven = exports.ColorByFairR = exports.ColorByGoodR = exports.ColorByGreatR = exports.EthnicTextColor = exports.ColorByBlackAsian = exports.ColorByAsianHispanic = exports.ColorByAsianWhite = exports.ColorByHispanicBlack = exports.ColorByBlackWhite = exports.ColorByHispanicWhite = exports.ColorByMix = exports.ColorByMostlyNative = exports.ColorByMostlyAsian = exports.ColorByMostlyHispanic = exports.ColorByMostlyBlack = exports.ColorByMostlyWhite = exports.ColorBySolidAsian = exports.ColorBySolidHispanic = exports.ColorBySolidBlack = exports.ColorBySolidWhite = void 0;
-exports.ColorFlags = exports.MaxFields = exports.FieldCountToColors = exports.BinColorLookup = exports.BinEthnicOther = exports.BinEthnicHispanic = void 0;
+exports.BinEthnicBlack = exports.BinEthnicWhite = exports.BinBlack = exports.BinDeepPink = exports.BinMagenta = exports.BinDarkViolet = exports.BinBlueViolet = exports.BinBlue = exports.BinLightBlue = exports.BinCyan = exports.BinMediumSpringGreen = exports.BinLime = exports.BinChartreuse = exports.BinGreenish = exports.BinYellow = exports.BinGold = exports.BinOrange = exports.BinBrown = exports.BinOrangeRed = exports.BinRed = exports.PaletteNames = exports.DefaultPaletteDefaults = exports.ColorBrewerSchemeStops = exports.EthnicFewStops = exports.PartisanPrecinctStops = exports.PartisanDistrictStops = exports.ColorByGreatD = exports.ColorByGoodD = exports.ColorByFairD = exports.ColorByEven = exports.ColorByFairR = exports.ColorByGoodR = exports.ColorByGreatR = exports.EthnicTextColor = exports.ColorByBlackAsian = exports.ColorByAsianHispanic = exports.ColorByAsianWhite = exports.ColorByHispanicBlack = exports.ColorByBlackWhite = exports.ColorByHispanicWhite = exports.ColorByMix = exports.ColorByMostlyNative = exports.ColorByMostlyAsian = exports.ColorByMostlyHispanic = exports.ColorByMostlyBlack = exports.ColorByMostlyWhite = exports.ColorBySolidAsian = exports.ColorBySolidHispanic = exports.ColorBySolidBlack = exports.ColorBySolidWhite = void 0;
+exports.ColorFlags = exports.MaxFields = exports.FieldCountToColors = exports.BinColorLookup = exports.BinEthnicOther = exports.BinEthnicHispanic = exports.BinEthnicAsian = void 0;
 exports.makeStops = makeStops;
+exports.partisanStops = partisanStops;
+exports.partisanDistrictStops = partisanDistrictStops;
+exports.ethnicStops = ethnicStops;
 exports.ethnicBackgroundColor = ethnicBackgroundColor;
 exports.ToAllEthnicColor = ToAllEthnicColor;
 exports.ToPartisanColorStr = ToPartisanColorStr;
@@ -133,8 +136,6 @@ exports.AggregateEthnicColor = AggregateEthnicColor;
 exports.AggregatePartisanColor = AggregatePartisanColor;
 exports.AggregatePartisanColorStr = AggregatePartisanColorStr;
 exports.ColorFromRGBPcts = ColorFromRGBPcts;
-exports.colorsFromStops = colorsFromStops;
-exports.colorsFromStopsPartisan = colorsFromStopsPartisan;
 exports.allGroups16Colors = allGroups16Colors;
 exports.ToExtendedColor = ToExtendedColor;
 exports.computeDistrictColors = computeDistrictColors;
@@ -251,6 +252,9 @@ exports.EthnicFewStops = [
     0.50, //
     1.00, // 
 ];
+exports.ColorBrewerSchemeStops = [
+    0.00, 0.125, 0.125, 0.25, 0.25, 0.375, 0.375, 0.50, 0.50, 0.625, 0.625, 0.75, 0.75, 0.875, 0.875, 1.00
+];
 exports.DefaultPaletteDefaults = {
     partisanScale: 'partisanclassic',
     partisanDistrictsScale: 'partisandistrictsclassic',
@@ -265,18 +269,23 @@ function makeStops(stops, colors) {
         result.push({ stop: stops[i], color: colors[i] });
     return result;
 }
-function partisanStops(stops, pd) {
-    const palette = pd['partisanScale'];
+// *************** Color functions ***********************
+// These 3 functions: partisanStops, partisanDistrictStops, ethnicStops, check for Color Brewer schemes
+function partisanStops(stops, palette) {
+    if (baseclient_1.Colors.BigPalettes.indexOf(palette) < 0) // not a big palette
+        stops = exports.ColorBrewerSchemeStops;
     return makeStops(stops, colorsFromStopsPartisan(palette, 'partisanScale', stops));
 }
-function partisanDistrictStops(stops, pd) {
-    const palette = pd['partisanDistrictsScale'];
+function partisanDistrictStops(stops, palette) {
+    if (baseclient_1.Colors.BigPalettes.indexOf(palette) < 0) // not a big palette
+        stops = exports.ColorBrewerSchemeStops;
     return makeStops(stops, colorsFromStopsPartisan(palette, 'partisanDistrictsScale', stops));
 }
-function ethnicStops(stops, pd) {
-    const palette = pd['demographicsScale'];
+function ethnicStops(stops, palette) {
     if (palette === 'demographicsclassic')
         return makeStops(stops, baseclient_1.Colors.EthnicFewClassicColors);
+    if (baseclient_1.Colors.BigPalettes.indexOf(palette) < 0) // not a big palette
+        stops = exports.ColorBrewerSchemeStops;
     return makeStops(stops, colorsFromStops(palette, stops, baseclient_1.Colors.EthnicFewClassicColors));
 }
 function ethnicBackgroundColor(index, pd) {
@@ -294,10 +303,10 @@ function ToAllEthnicColor(agg, dc, pd) {
     return AggregateEthnicColor(PF.ToGetter(agg, dc, did), pd, builtin.endsWith('NH'));
 }
 function ToPartisanColorStr(agg, dc, pd) {
-    return ToPartisanColor(agg, dc, partisanStops(exports.PartisanPrecinctStops, pd));
+    return ToPartisanColor(agg, dc, partisanStops(exports.PartisanPrecinctStops, pd['partisanScale']));
 }
 function ToPartisanDistrictColor(agg, dc, pd) {
-    return ToPartisanColor(agg, dc, partisanDistrictStops(exports.PartisanDistrictStops, pd));
+    return ToPartisanColor(agg, dc, partisanDistrictStops(exports.PartisanDistrictStops, pd['partisanDistrictsScale']));
 }
 function ToPartisanColor(agg, dc, stops) {
     const getter = PF.ToGetter(agg, dc, dc.primeEDS);
@@ -312,7 +321,7 @@ function ToPartisanShiftColor(agg, dc, datasets, pd, isDistrict) {
     const defaultIsDistrict = isDistrict !== null && isDistrict !== void 0 ? isDistrict : false; // make the optional isDistrict parameter to false by default
     const rep = 0.5 - (shift / 2);
     const dem = 0.5 + (shift / 2);
-    const stops = defaultIsDistrict ? partisanDistrictStops(exports.PartisanDistrictStops, pd) : partisanStops(exports.PartisanPrecinctStops, pd);
+    const stops = defaultIsDistrict ? partisanDistrictStops(exports.PartisanDistrictStops, pd['partisanDistrictsScale']) : partisanStops(exports.PartisanPrecinctStops, pd['partisanScale']);
     const color = ColorFromRGBPcts(rep, 0, dem, stops);
     // console.log('Shift (r, d, color): (' + rep + ', ' + dem + ', ' + color + ')');
     return color;
@@ -371,7 +380,7 @@ function ToEthnicColorStr(agg, dc, pd, detail) {
     if (den == 0)
         return '#ffffff';
     const pct = bInvert ? 1 - (num / den) : num / den;
-    return baseclient_1.Util.execGradient(ethnicStops(exports.EthnicFewStops, pd), pct);
+    return baseclient_1.Util.execGradient(ethnicStops(exports.EthnicFewStops, pd['demographicsScale']), pct);
 }
 // All Groups Mosaic
 function AggregateEthnicColor(getter, pd, nhAlone) {
@@ -483,12 +492,17 @@ function ColorFromRGBPcts(pctRed, pctGreen, pctBlue, stops) {
     pctBlue /= pctTot;
     return baseclient_1.Util.execGradient(stops, pctBlue);
 }
-// Currently supported palettes
+// Currently supported palettes (not including Color Brewer schemes)
 exports.PaletteNames = ['jet_r', 'turbo_r', 'inferno_r', 'viridis_r', 'magma_r', 'plasma_r', 'Greys', 'bone_r',
     'draclassic', 'demographicsclassic', 'partisanclassic', 'allgroupsclassic', 'partisandistrictsclassic'];
 function colorsFromStops(palette, stops, classicColors) {
-    // Use classicColors to see where there are duplicate colors
     const allColors = baseclient_1.Colors.getPalette(palette);
+    if (allColors.length < baseclient_1.Colors.MaxColors) {
+        if (allColors.length != 8) // Color Brewer Schemes are only 8 colors
+            return classicColors; // Safety check; shouldn't happen
+        return colorBrewerColors(stops, allColors);
+    }
+    // Use classicColors to see where there are duplicate colors
     let colors = [];
     for (let i = 0; i < stops.length; i++) {
         const stop = (i + 1 < classicColors.length && classicColors[i] == classicColors[i + 1]) ? (stops[i] + stops[i + 1]) / 2 :
@@ -507,13 +521,26 @@ function colorsFromStopsPartisan(palette, colorUse, stops) {
         return baseclient_1.Colors.PartisanDistrictClassicColors;
     // For partisanScale and partisanDistrictsScale; indexes match classic color pattern
     const allColors = baseclient_1.Colors.getPalette(palette);
-    if (allColors.length < baseclient_1.Colors.MaxColors)
-        return baseclient_1.Colors.PartisanPrecinctClassicColors; // Safety check; shouldn't happen
+    if (allColors.length < baseclient_1.Colors.MaxColors) {
+        if (allColors.length != 8) // Color Brewer Schemes are only 8 colors
+            return baseclient_1.Colors.PartisanPrecinctClassicColors; // Safety check; shouldn't happen
+        return colorBrewerColors(stops, allColors);
+    }
     let colors = [];
     const indexes = colorUse === 'partisanScale' ?
         [15, 27, 37, 47, 57, 67, 82, 92, 102, 112, 122, 134] : [15, 15, 37, 37, 47, 67, 82, 102, 122, 122, 134, 134];
-    for (let i = 0; i < stops.length; i++) {
+    for (let i = 0; i < stops.length; i++)
         colors.push(allColors[indexes[i]]);
+    return colors;
+}
+function colorBrewerColors(stops, allColors) {
+    // Do each color twice (expecting 16 stops)
+    const colors = [];
+    for (let i = 0; i < stops.length; i++) {
+        let colorInx = Math.floor(i / 2);
+        if (colorInx >= allColors.length)
+            colorInx = allColors.length - 1;
+        colors.push(allColors[colorInx]);
     }
     return colors;
 }
@@ -1408,6 +1435,8 @@ exports.formColorBy = formColorBy;
 exports.parseColorBy = parseColorBy;
 exports.isColorBy = isColorBy;
 exports.datasetRestrict = datasetRestrict;
+exports.defaultBuiltinKeys = defaultBuiltinKeys;
+exports.usesPrisonerAdjust = usesPrisonerAdjust;
 function sortFields(f1, f2) {
     return (f1.order || 0) - (f2.order || 0);
 }
@@ -1433,6 +1462,48 @@ function datasetRestrict(ds) {
         return ds.meta[ds.id].restrict;
     return null;
 }
+;
+function defaultBuiltinKeys(state, datasource, planType, builtins) {
+    function bestOf(a) { return a.find(s => builtins.has(s)); }
+    return (datasource === '2020_VD')
+        ? {
+            CENSUS: bestOf((usesPrisonerAdjust(state, datasource, planType)
+                ? ['D20FA', 'D20F', 'D19F', 'D18F']
+                : ['D20F', 'D19F', 'D18F'])),
+            VAP: bestOf(['D20T', 'D19T', 'D18T']),
+            ELECTION: bestOf(['C16GCO', 'E20GPR', 'E16GPR'])
+        }
+        :
+            {
+                CENSUS: bestOf(['D10F', 'D16F']),
+                VAP: bestOf(['D10T', 'D16T']),
+                ELECTION: bestOf(['C16GCO', 'E20GPR', 'E16GPR', 'E08GPR'])
+            };
+}
+// Hard-coded based on both the existence of the dataset and the legal requirements of that particular state
+// (e.g. NY uses for state house maps but not congressional maps). So that is why we hard-code rather than
+// derive from dataset metadata.
+//
+function usesPrisonerAdjust(state, datasource, planType) {
+    if (datasource !== '2020_VD')
+        return false;
+    switch (state) {
+        case 'CA':
+        case 'DE':
+        case 'MD':
+        case 'NJ':
+        case 'NV':
+        case 'PA':
+        case 'VA':
+        case 'WA':
+            return (planType === 'congress' || planType === 'upper' || planType === 'lower' || planType === 'coi');
+        case 'CO':
+        case 'CT':
+        case 'NY':
+            return (planType === 'upper' || planType === 'lower' || planType === 'coi');
+    }
+    return false;
+}
 
 
 /***/ }),