Interface LensableDisplayStyle

interface LensableDisplayStyle {
    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?:
        | "model"
        | "fill"
        | "fill-extrusion"
        | "circle"
        | "icon"
        | "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;
}

Properties

baseHeightKey? circleRadius? cluster? clusterColor? displayKeys? fillOpacity? heightKey? heightScale? iconColor? iconHaloColor? iconImage? iconSize? lineColor? lineDimension? lineWidth? mainColor? mainLayer? overrideCircle? overrideFill? overrideFillExtrusion? overrideIcon? overrideLabel? overrideLine? overrideModel? primaryLabelMaxChars? props? showLabels? showLines? showPalette? showTable? showValuesOnly? tableColumnWidths? textColor? textHaloColor?

Properties

OptionalbaseHeightKey

baseHeightKey?: string

OptionalcircleRadius

circleRadius?: number

Optionalcluster

cluster?: boolean

OptionalclusterColor

clusterColor?: string

OptionaldisplayKeys

displayKeys?: string[]

Keys to use for labels on map

OptionalfillOpacity

fillOpacity?: number

OptionalheightKey

heightKey?: string

OptionalheightScale

heightScale?: number

OptionaliconColor

iconColor?: ColorPaletteOrFixed

OptionaliconHaloColor

iconHaloColor?: ColorPaletteOrFixed

OptionaliconImage

iconImage?: string

OptionaliconSize

iconSize?: number

OptionallineColor

lineColor?: ColorPaletteOrFixed

OptionallineDimension

lineDimension?: "meters" | "pixels"

OptionallineWidth

lineWidth?: number

OptionalmainColor

mainColor?: ColorPaletteOrFixed

OptionalmainLayer

mainLayer?:
    | "model"
    | "fill"
    | "fill-extrusion"
    | "circle"
    | "icon"
    | "giraffe-baked"

OptionaloverrideCircle

overrideCircle?: Pick<CircleLayerSpecification, "paint">

paint properties documented at https://docs.mapbox.com/style-spec/reference/layers/#circle

OptionaloverrideFill

overrideFill?: Pick<FillLayerSpecification, "paint">

paint properties documented at https://docs.mapbox.com/style-spec/reference/layers/#fill

OptionaloverrideFillExtrusion

overrideFillExtrusion?: Pick<FillExtrusionLayerSpecification, "paint" | "layout">

paint documented at https://docs.mapbox.com/style-spec/reference/layers/#fill-extrusion

OptionaloverrideIcon

overrideIcon?: Pick<SymbolLayerSpecification, "paint" | "layout">

paint and layout properties documented at https://docs.mapbox.com/style-spec/reference/layers/#symbol

OptionaloverrideLabel

overrideLabel?: Pick<SymbolLayerSpecification, "paint" | "layout">

paint and layout properties documented at https://docs.mapbox.com/style-spec/reference/layers/#symbol

OptionaloverrideLine

overrideLine?: Pick<LineLayerSpecification, "paint" | "layout">

paint and layout properties documented at https://docs.mapbox.com/style-spec/reference/layers/#line

OptionaloverrideModel

overrideModel?: Pick<ModelLayerSpecification, "paint" | "layout">

paint properties documented at https://docs.mapbox.com/style-spec/reference/layers/#model

OptionalprimaryLabelMaxChars

primaryLabelMaxChars?: number

Optionalprops

props?: PropToProp[]

OptionalshowLabels

showLabels?: boolean

OptionalshowLines

showLines?: boolean

OptionalshowPalette

showPalette?: LensPaletteKey

OptionalshowTable

showTable?: boolean

OptionalshowValuesOnly

showValuesOnly?: boolean

OptionaltableColumnWidths

tableColumnWidths?: Record<string, number>

OptionaltextColor

textColor?: ColorPaletteOrFixed

OptionaltextHaloColor

textHaloColor?: ColorPaletteOrFixed

Settings

Member Visibility

On This Page

Properties