gi-nx

---

gi-nx / GiraffeLensableStyle

type GiraffeLensableStyle = {
  aggregateBy?: string;
  columnDef?: Record<string, LensTypedProperty>;
  columnKeys?: string[];
  filter?: AdvancedFeatureFilter;
  filterMode?: FilterMode;
  promoteId?: string;
  sortBy?: SortBy[];
  sortDescending?: boolean;
  sourceLayer?: string;
  baseHeightKey?: string;
  circleRadius?: number;
  cluster?: boolean;
  clusterColor?: string;
  displayKeys?: string[];
  fillOpacity?: number;
  heightKey?: string;
  heightScale?: number;
  iconColor?: ColorPaletteOrFixed;
  iconHaloColor?: ColorPaletteOrFixed;
  iconImage?: string;
  iconSize?: number;
  lineColor?: ColorPaletteOrFixed;
  lineDimension?: "meters" | "pixels";
  lineWidth?: number;
  mainColor?: ColorPaletteOrFixed;
  mainLayer?: "fill" | "fill-extrusion" | "circle" | "icon" | "model" | "giraffe-baked";
  overrideCircle?: Pick<CircleLayerSpecification, "paint">;
  overrideFill?: Pick<FillLayerSpecification, "paint">;
  overrideFillExtrusion?: Pick<FillExtrusionLayerSpecification, "paint" | "layout">;
  overrideIcon?: Pick<SymbolLayerSpecification, "paint" | "layout">;
  overrideLabel?: Pick<SymbolLayerSpecification, "paint" | "layout">;
  overrideLine?: Pick<LineLayerSpecification, "paint" | "layout">;
  overrideModel?: Pick<ModelLayerSpecification, "paint" | "layout">;
  primaryLabelMaxChars?: number;
  props?: PropToProp[];
  showLabels?: boolean;
  showLines?: boolean;
  showPalette?: LensPaletteKey;
  showTable?: boolean;
  showValuesOnly?: boolean;
  tableColumnWidths?: Record<string, number>;
  textColor?: ColorPaletteOrFixed;
  textHaloColor?: ColorPaletteOrFixed;
};

Type Declaration

Name	Type	Description
aggregateBy?	string	-
columnDef?	Record<string, LensTypedProperty>	-
columnKeys?	string[]	opt-in to show specific columns.
filter?	AdvancedFeatureFilter	-
filterMode?	FilterMode	-
promoteId?	string	-
sortBy?	SortBy[]	-
sourceLayer?	string	-
baseHeightKey?	string	-
circleRadius?	number	-
cluster?	boolean	-
clusterColor?	string	-
displayKeys?	string[]	Keys to use for labels on map
fillOpacity?	number	-
heightKey?	string	-
heightScale?	number	-
iconColor?	ColorPaletteOrFixed	-
iconHaloColor?	ColorPaletteOrFixed	-
iconImage?	string	-
iconSize?	number	-
lineColor?	ColorPaletteOrFixed	-
lineDimension?	"meters" | "pixels"	-
lineWidth?	number	-
mainColor?	ColorPaletteOrFixed	-
mainLayer?	"fill" | "fill-extrusion" | "circle" | "icon" | "model" | "giraffe-baked"	-
overrideCircle?	Pick<CircleLayerSpecification, "paint">	paint properties documented at https://docs.mapbox.com/style-spec/reference/layers/#circle
overrideFill?	Pick<FillLayerSpecification, "paint">	paint properties documented at https://docs.mapbox.com/style-spec/reference/layers/#fill
overrideFillExtrusion?	Pick<FillExtrusionLayerSpecification, "paint" | "layout">	paint documented at https://docs.mapbox.com/style-spec/reference/layers/#fill-extrusion
overrideIcon?	Pick<SymbolLayerSpecification, "paint" | "layout">	paint and layout properties documented at https://docs.mapbox.com/style-spec/reference/layers/#symbol
overrideLabel?	Pick<SymbolLayerSpecification, "paint" | "layout">	paint and layout properties documented at https://docs.mapbox.com/style-spec/reference/layers/#symbol
overrideLine?	Pick<LineLayerSpecification, "paint" | "layout">	paint and layout properties documented at https://docs.mapbox.com/style-spec/reference/layers/#line
overrideModel?	Pick<ModelLayerSpecification, "paint" | "layout">	paint properties documented at https://docs.mapbox.com/style-spec/reference/layers/#model
primaryLabelMaxChars?	number	-
props?	PropToProp[]	-
showLabels?	boolean	-
showLines?	boolean	-
showPalette?	LensPaletteKey	-
showTable?	boolean	-
showValuesOnly?	boolean	-
tableColumnWidths?	Record<string, number>	-
textColor?	ColorPaletteOrFixed	-
textHaloColor?	ColorPaletteOrFixed	-