# Interface: SymbolOptions
# Hierarchy
-
↳ SymbolOptions
# Table of contents
# Properties
- data
- filter
- iconAllowOverlap
- iconAnchor
- iconColor
- iconHaloBlur
- iconHaloColor
- iconHaloWidth
- iconIgnorePlacement
- iconImage
- iconKeepUpright
- iconOffset
- iconOpacity
- iconOptional
- iconPadding
- iconPitchAlignment
- iconRotate
- iconRotationAlignment
- iconSize
- iconTextFit
- iconTextFitPadding
- iconTranslate
- iconTranslateAnchor
- isHoverFeatureState
- isHoverPointer
- layerId
- maxzoom
- minzoom
- sourceId
- sourceLayer
- symbolAvoidEdges
- symbolPlacement
- symbolSortKey
- symbolSpacing
- symbolZOrder
- textAllowOverlap
- textAnchor
- textColor
- textField
- textFont
- textHaloBlur
- textHaloColor
- textHaloWidth
- textIgnorePlacement
- textJustify
- textKeepUpright
- textLetterSpacing
- textLineHeight
- textMaxAngle
- textMaxWidth
- textOffset
- textOpacity
- textOptional
- textPadding
- textPitchAlignment
- textRadialOffset
- textRotate
- textRotationAlignment
- textSize
- textTransform
- textTranslate
- textTranslateAnchor
- textVariableAnchor
- textWritingMode
- visibility
# Properties
# data
• data: any
# filter
• Optional filter: any
Inherited from: OverlayLayerBaseOptions.filter
# iconAllowOverlap
• Optional iconAllowOverlap: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }
# iconAnchor
• Optional iconAnchor: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | ExpressionSpecificationEx | { stops: [number, Anchor][] ; type: "exponential" } | { stops: [number, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [number, Anchor][] ; type: "exponential" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [number, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [string | number | boolean, Anchor][] ; type: "categorical" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; type: "identity" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: number ; zoom: number }, Anchor][] ; type: "exponential" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: number ; zoom: number }, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, Anchor][] ; type: "categorical" }
# iconColor
• Optional iconColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }
# iconHaloBlur
• Optional iconHaloBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }
# iconHaloColor
• Optional iconHaloColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }
# iconHaloWidth
• Optional iconHaloWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }
# iconIgnorePlacement
• Optional iconIgnorePlacement: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }
# iconImage
• Optional iconImage: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }
# iconKeepUpright
• Optional iconKeepUpright: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }
# iconOffset
• Optional iconOffset: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [number, [number, number]][] ; type: "exponential" } | { default?: [number, number] ; property: string ; stops: [number, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [string | number | boolean, [number, number]][] ; type: "categorical" } | { default?: [number, number] ; property: string ; type: "identity" } | { default?: [number, number] ; property: string ; stops: [{ value: number ; zoom: number }, [number, number]][] ; type: "exponential" } | { default?: [number, number] ; property: string ; stops: [{ value: number ; zoom: number }, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, [number, number]][] ; type: "categorical" }
# iconOpacity
• Optional iconOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }
# iconOptional
• Optional iconOptional: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }
# iconPadding
• Optional iconPadding: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }
# iconPitchAlignment
• Optional iconPitchAlignment: "map" | ExpressionSpecificationEx | "viewport" | "auto" | { stops: [number, "map" | "viewport" | "auto"][] ; type: "exponential" } | { stops: [number, "map" | "viewport" | "auto"][] ; type: "interval" }
# iconRotate
• Optional iconRotate: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }
# iconRotationAlignment
• Optional iconRotationAlignment: "map" | ExpressionSpecificationEx | "viewport" | "auto" | { stops: [number, "map" | "viewport" | "auto"][] ; type: "exponential" } | { stops: [number, "map" | "viewport" | "auto"][] ; type: "interval" }
# iconSize
• Optional iconSize: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }
# iconTextFit
• Optional iconTextFit: ExpressionSpecificationEx | "none" | "width" | "height" | "both" | { stops: [number, "none" | "width" | "height" | "both"][] ; type: "exponential" } | { stops: [number, "none" | "width" | "height" | "both"][] ; type: "interval" }
# iconTextFitPadding
• Optional iconTextFitPadding: [number, number, number, number] | ExpressionSpecificationEx | { stops: [number, [number, number, number, number]][] ; type: "exponential" } | { stops: [number, [number, number, number, number]][] ; type: "interval" }
# iconTranslate
• Optional iconTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }
# iconTranslateAnchor
• Optional iconTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }
# isHoverFeatureState
• Optional isHoverFeatureState: boolean
Inherited from: OverlayLayerBaseOptions.isHoverFeatureState
# isHoverPointer
• Optional isHoverPointer: boolean
Inherited from: OverlayLayerBaseOptions.isHoverPointer
# layerId
• Optional layerId: string
Inherited from: OverlayLayerBaseOptions.layerId
# maxzoom
• Optional maxzoom: number
Inherited from: OverlayLayerBaseOptions.maxzoom
# minzoom
• Optional minzoom: number
Inherited from: OverlayLayerBaseOptions.minzoom
# sourceId
• Optional sourceId: string
Inherited from: OverlayLayerBaseOptions.sourceId
# sourceLayer
• Optional sourceLayer: string
Inherited from: OverlayLayerBaseOptions.sourceLayer
# symbolAvoidEdges
• Optional symbolAvoidEdges: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }
# symbolPlacement
• Optional symbolPlacement: "line" | ExpressionSpecificationEx | "point" | "line-center" | { stops: [number, "line" | "point" | "line-center"][] ; type: "exponential" } | { stops: [number, "line" | "point" | "line-center"][] ; type: "interval" }
# symbolSortKey
• Optional symbolSortKey: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }
# symbolSpacing
• Optional symbolSpacing: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }
# symbolZOrder
• Optional symbolZOrder: "source" | ExpressionSpecificationEx | "auto" | "viewport-y" | { stops: [number, "source" | "auto" | "viewport-y"][] ; type: "exponential" } | { stops: [number, "source" | "auto" | "viewport-y"][] ; type: "interval" }
# textAllowOverlap
• Optional textAllowOverlap: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }
# textAnchor
• Optional textAnchor: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | ExpressionSpecificationEx | { stops: [number, Anchor][] ; type: "exponential" } | { stops: [number, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [number, Anchor][] ; type: "exponential" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [number, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [string | number | boolean, Anchor][] ; type: "categorical" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; type: "identity" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: number ; zoom: number }, Anchor][] ; type: "exponential" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: number ; zoom: number }, Anchor][] ; type: "interval" } | { default?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, Anchor][] ; type: "categorical" }
# textColor
• Optional textColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }
# textField
• Optional textField: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }
# textFont
• Optional textFont: string[] | ExpressionSpecificationEx | { stops: [number, string[]][] ; type: "exponential" } | { stops: [number, string[]][] ; type: "interval" } | { default?: string[] ; property: string ; stops: [number, string[]][] ; type: "exponential" } | { default?: string[] ; property: string ; stops: [number, string[]][] ; type: "interval" } | { default?: string[] ; property: string ; stops: [string | number | boolean, string[]][] ; type: "categorical" } | { default?: string[] ; property: string ; type: "identity" } | { default?: string[] ; property: string ; stops: [{ value: number ; zoom: number }, string[]][] ; type: "exponential" } | { default?: string[] ; property: string ; stops: [{ value: number ; zoom: number }, string[]][] ; type: "interval" } | { default?: string[] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string[]][] ; type: "categorical" }
# textHaloBlur
• Optional textHaloBlur: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }
# textHaloColor
• Optional textHaloColor: string | ExpressionSpecificationEx | { stops: [number, string][] ; type: "exponential" } | { stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [number, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [number, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [string | number | boolean, string][] ; type: "categorical" } | { default?: string ; property: string ; type: "identity" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "exponential" } | { default?: string ; property: string ; stops: [{ value: number ; zoom: number }, string][] ; type: "interval" } | { default?: string ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, string][] ; type: "categorical" }
# textHaloWidth
• Optional textHaloWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }
# textIgnorePlacement
• Optional textIgnorePlacement: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }
# textJustify
• Optional textJustify: "center" | "left" | "right" | ExpressionSpecificationEx | "auto" | { stops: [number, "center" | "left" | "right" | "auto"][] ; type: "exponential" } | { stops: [number, "center" | "left" | "right" | "auto"][] ; type: "interval" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [number, "center" | "left" | "right" | "auto"][] ; type: "exponential" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [number, "center" | "left" | "right" | "auto"][] ; type: "interval" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [string | number | boolean, "center" | "left" | "right" | "auto"][] ; type: "categorical" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; type: "identity" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [{ value: number ; zoom: number }, "center" | "left" | "right" | "auto"][] ; type: "exponential" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [{ value: number ; zoom: number }, "center" | "left" | "right" | "auto"][] ; type: "interval" } | { default?: "center" | "left" | "right" | "auto" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "center" | "left" | "right" | "auto"][] ; type: "categorical" }
# textKeepUpright
• Optional textKeepUpright: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }
# textLetterSpacing
• Optional textLetterSpacing: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }
# textLineHeight
• Optional textLineHeight: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }
# textMaxAngle
• Optional textMaxAngle: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }
# textMaxWidth
• Optional textMaxWidth: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }
# textOffset
• Optional textOffset: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [number, [number, number]][] ; type: "exponential" } | { default?: [number, number] ; property: string ; stops: [number, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [string | number | boolean, [number, number]][] ; type: "categorical" } | { default?: [number, number] ; property: string ; type: "identity" } | { default?: [number, number] ; property: string ; stops: [{ value: number ; zoom: number }, [number, number]][] ; type: "exponential" } | { default?: [number, number] ; property: string ; stops: [{ value: number ; zoom: number }, [number, number]][] ; type: "interval" } | { default?: [number, number] ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, [number, number]][] ; type: "categorical" }
# textOpacity
• Optional textOpacity: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }
# textOptional
• Optional textOptional: boolean | ExpressionSpecificationEx | { stops: [number, boolean][] ; type: "exponential" } | { stops: [number, boolean][] ; type: "interval" }
# textPadding
• Optional textPadding: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" }
# textPitchAlignment
• Optional textPitchAlignment: "map" | ExpressionSpecificationEx | "viewport" | "auto" | { stops: [number, "map" | "viewport" | "auto"][] ; type: "exponential" } | { stops: [number, "map" | "viewport" | "auto"][] ; type: "interval" }
# textRadialOffset
• Optional textRadialOffset: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }
# textRotate
• Optional textRotate: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }
# textRotationAlignment
• Optional textRotationAlignment: "map" | ExpressionSpecificationEx | "viewport" | "auto" | { stops: [number, "map" | "viewport" | "auto"][] ; type: "exponential" } | { stops: [number, "map" | "viewport" | "auto"][] ; type: "interval" }
# textSize
• Optional textSize: number | ExpressionSpecificationEx | { stops: [number, number][] ; type: "exponential" } | { stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [number, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [number, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [string | number | boolean, number][] ; type: "categorical" } | { default?: number ; property: string ; type: "identity" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "exponential" } | { default?: number ; property: string ; stops: [{ value: number ; zoom: number }, number][] ; type: "interval" } | { default?: number ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, number][] ; type: "categorical" }
# textTransform
• Optional textTransform: ExpressionSpecificationEx | "none" | "uppercase" | "lowercase" | { stops: [number, "none" | "uppercase" | "lowercase"][] ; type: "exponential" } | { stops: [number, "none" | "uppercase" | "lowercase"][] ; type: "interval" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [number, "none" | "uppercase" | "lowercase"][] ; type: "exponential" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [number, "none" | "uppercase" | "lowercase"][] ; type: "interval" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [string | number | boolean, "none" | "uppercase" | "lowercase"][] ; type: "categorical" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; type: "identity" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [{ value: number ; zoom: number }, "none" | "uppercase" | "lowercase"][] ; type: "exponential" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [{ value: number ; zoom: number }, "none" | "uppercase" | "lowercase"][] ; type: "interval" } | { default?: "none" | "uppercase" | "lowercase" ; property: string ; stops: [{ value: string | number | boolean ; zoom: number }, "none" | "uppercase" | "lowercase"][] ; type: "categorical" }
# textTranslate
• Optional textTranslate: [number, number] | ExpressionSpecificationEx | { stops: [number, [number, number]][] ; type: "exponential" } | { stops: [number, [number, number]][] ; type: "interval" }
# textTranslateAnchor
• Optional textTranslateAnchor: "map" | ExpressionSpecificationEx | "viewport" | { stops: [number, "map" | "viewport"][] ; type: "exponential" } | { stops: [number, "map" | "viewport"][] ; type: "interval" }
# textVariableAnchor
• Optional textVariableAnchor: ExpressionSpecificationEx | Anchor[] | { stops: [number, Anchor[]][] ; type: "exponential" } | { stops: [number, Anchor[]][] ; type: "interval" }
# textWritingMode
• Optional textWritingMode: ExpressionSpecificationEx | ("vertical" | "horizontal")[] | { stops: [number, ("vertical" | "horizontal")[]][] ; type: "exponential" } | { stops: [number, ("vertical" | "horizontal")[]][] ; type: "interval" }
# visibility
• Optional visibility: "visible" | "none"
Inherited from: OverlayLayerBaseOptions.visibility