# Interface: IAnimateSymbolLayerOptions
# Hierarchy
Omit<SymbolOptions,
"data"
>↳ IAnimateSymbolLayerOptions
# Table of contents
# Properties
- animateImages
- filter
- iconAllowOverlap
- iconAnchor
- iconColor
- iconHaloBlur
- iconHaloColor
- iconHaloWidth
- iconIgnorePlacement
- iconImage
- iconKeepUpright
- iconOffset
- iconOpacity
- iconOptional
- iconPadding
- iconPitchAlignment
- iconRotate
- iconRotationAlignment
- iconSize
- iconTextFit
- iconTextFitPadding
- iconTranslate
- iconTranslateAnchor
- isHoverFeatureState
- isHoverPointer
- layerBefore
- layerId
- maxzoom
- minzoom
- sourceId
- sourceLayer
- speed
- startAutoAnimation
- 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
# animateImages
• Optional
animateImages: (string | ArrayBufferView | ImageData | HTMLImageElement | ImageBitmap | { data
: Uint8Array | Uint8ClampedArray ; height
: number ; width
: number })[]
动画图集.
# filter
• Optional
filter: any
Inherited from: Omit.filter
# iconAllowOverlap
• Optional
iconAllowOverlap: boolean | ExpressionSpecificationEx | { stops
: [number, boolean][] ; type
: "exponential"
} | { stops
: [number, boolean][] ; type
: "interval"
}
Inherited from: Omit.iconAllowOverlap
# 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"
}
Inherited from: Omit.iconAnchor
# 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"
}
Inherited from: Omit.iconColor
# 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"
}
Inherited from: Omit.iconHaloBlur
# 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"
}
Inherited from: Omit.iconHaloColor
# 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"
}
Inherited from: Omit.iconHaloWidth
# iconIgnorePlacement
• Optional
iconIgnorePlacement: boolean | ExpressionSpecificationEx | { stops
: [number, boolean][] ; type
: "exponential"
} | { stops
: [number, boolean][] ; type
: "interval"
}
Inherited from: Omit.iconIgnorePlacement
# 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"
}
Inherited from: Omit.iconImage
# iconKeepUpright
• Optional
iconKeepUpright: boolean | ExpressionSpecificationEx | { stops
: [number, boolean][] ; type
: "exponential"
} | { stops
: [number, boolean][] ; type
: "interval"
}
Inherited from: Omit.iconKeepUpright
# 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"
}
Inherited from: Omit.iconOffset
# 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"
}
Inherited from: Omit.iconOpacity
# iconOptional
• Optional
iconOptional: boolean | ExpressionSpecificationEx | { stops
: [number, boolean][] ; type
: "exponential"
} | { stops
: [number, boolean][] ; type
: "interval"
}
Inherited from: Omit.iconOptional
# iconPadding
• Optional
iconPadding: number | ExpressionSpecificationEx | { stops
: [number, number][] ; type
: "exponential"
} | { stops
: [number, number][] ; type
: "interval"
}
Inherited from: Omit.iconPadding
# iconPitchAlignment
• Optional
iconPitchAlignment: "map"
| ExpressionSpecificationEx | "viewport"
| "auto"
| { stops
: [number, "map"
| "viewport"
| "auto"
][] ; type
: "exponential"
} | { stops
: [number, "map"
| "viewport"
| "auto"
][] ; type
: "interval"
}
Inherited from: Omit.iconPitchAlignment
# 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"
}
Inherited from: Omit.iconRotate
# iconRotationAlignment
• Optional
iconRotationAlignment: "map"
| ExpressionSpecificationEx | "viewport"
| "auto"
| { stops
: [number, "map"
| "viewport"
| "auto"
][] ; type
: "exponential"
} | { stops
: [number, "map"
| "viewport"
| "auto"
][] ; type
: "interval"
}
Inherited from: Omit.iconRotationAlignment
# 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"
}
Inherited from: Omit.iconSize
# iconTextFit
• Optional
iconTextFit: ExpressionSpecificationEx | "none"
| "width"
| "height"
| "both"
| { stops
: [number, "none"
| "width"
| "height"
| "both"
][] ; type
: "exponential"
} | { stops
: [number, "none"
| "width"
| "height"
| "both"
][] ; type
: "interval"
}
Inherited from: Omit.iconTextFit
# iconTextFitPadding
• Optional
iconTextFitPadding: [number, number, number, number] | ExpressionSpecificationEx | { stops
: [number, [number, number, number, number]][] ; type
: "exponential"
} | { stops
: [number, [number, number, number, number]][] ; type
: "interval"
}
Inherited from: Omit.iconTextFitPadding
# iconTranslate
• Optional
iconTranslate: [number, number] | ExpressionSpecificationEx | { stops
: [number, [number, number]][] ; type
: "exponential"
} | { stops
: [number, [number, number]][] ; type
: "interval"
}
Inherited from: Omit.iconTranslate
# iconTranslateAnchor
• Optional
iconTranslateAnchor: "map"
| ExpressionSpecificationEx | "viewport"
| { stops
: [number, "map"
| "viewport"
][] ; type
: "exponential"
} | { stops
: [number, "map"
| "viewport"
][] ; type
: "interval"
}
Inherited from: Omit.iconTranslateAnchor
# isHoverFeatureState
• Optional
isHoverFeatureState: boolean
Inherited from: Omit.isHoverFeatureState
# isHoverPointer
• Optional
isHoverPointer: boolean
Inherited from: Omit.isHoverPointer
# layerBefore
• Optional
layerBefore: string
创建的图层位于哪个图层之前.
# layerId
• Optional
layerId: string
Inherited from: Omit.layerId
# maxzoom
• Optional
maxzoom: number
Inherited from: Omit.maxzoom
# minzoom
• Optional
minzoom: number
Inherited from: Omit.minzoom
# sourceId
• Optional
sourceId: string
Inherited from: Omit.sourceId
# sourceLayer
• Optional
sourceLayer: string
Inherited from: Omit.sourceLayer
# speed
• Optional
speed: number
速度,默认1.
# startAutoAnimation
• Optional
startAutoAnimation: boolean
开始时自动动画,默认true.
# symbolAvoidEdges
• Optional
symbolAvoidEdges: boolean | ExpressionSpecificationEx | { stops
: [number, boolean][] ; type
: "exponential"
} | { stops
: [number, boolean][] ; type
: "interval"
}
Inherited from: Omit.symbolAvoidEdges
# symbolPlacement
• Optional
symbolPlacement: "line"
| ExpressionSpecificationEx | "point"
| "line-center"
| { stops
: [number, "line"
| "point"
| "line-center"
][] ; type
: "exponential"
} | { stops
: [number, "line"
| "point"
| "line-center"
][] ; type
: "interval"
}
Inherited from: Omit.symbolPlacement
# 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"
}
Inherited from: Omit.symbolSortKey
# symbolSpacing
• Optional
symbolSpacing: number | ExpressionSpecificationEx | { stops
: [number, number][] ; type
: "exponential"
} | { stops
: [number, number][] ; type
: "interval"
}
Inherited from: Omit.symbolSpacing
# symbolZOrder
• Optional
symbolZOrder: "source"
| ExpressionSpecificationEx | "auto"
| "viewport-y"
| { stops
: [number, "source"
| "auto"
| "viewport-y"
][] ; type
: "exponential"
} | { stops
: [number, "source"
| "auto"
| "viewport-y"
][] ; type
: "interval"
}
Inherited from: Omit.symbolZOrder
# textAllowOverlap
• Optional
textAllowOverlap: boolean | ExpressionSpecificationEx | { stops
: [number, boolean][] ; type
: "exponential"
} | { stops
: [number, boolean][] ; type
: "interval"
}
Inherited from: Omit.textAllowOverlap
# 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"
}
Inherited from: Omit.textAnchor
# 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"
}
Inherited from: Omit.textColor
# 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"
}
Inherited from: Omit.textField
# 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"
}
Inherited from: Omit.textFont
# 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"
}
Inherited from: Omit.textHaloBlur
# 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"
}
Inherited from: Omit.textHaloColor
# 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"
}
Inherited from: Omit.textHaloWidth
# textIgnorePlacement
• Optional
textIgnorePlacement: boolean | ExpressionSpecificationEx | { stops
: [number, boolean][] ; type
: "exponential"
} | { stops
: [number, boolean][] ; type
: "interval"
}
Inherited from: Omit.textIgnorePlacement
# 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"
}
Inherited from: Omit.textJustify
# textKeepUpright
• Optional
textKeepUpright: boolean | ExpressionSpecificationEx | { stops
: [number, boolean][] ; type
: "exponential"
} | { stops
: [number, boolean][] ; type
: "interval"
}
Inherited from: Omit.textKeepUpright
# 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"
}
Inherited from: Omit.textLetterSpacing
# 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"
}
Inherited from: Omit.textLineHeight
# textMaxAngle
• Optional
textMaxAngle: number | ExpressionSpecificationEx | { stops
: [number, number][] ; type
: "exponential"
} | { stops
: [number, number][] ; type
: "interval"
}
Inherited from: Omit.textMaxAngle
# 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"
}
Inherited from: Omit.textMaxWidth
# 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"
}
Inherited from: Omit.textOffset
# 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"
}
Inherited from: Omit.textOpacity
# textOptional
• Optional
textOptional: boolean | ExpressionSpecificationEx | { stops
: [number, boolean][] ; type
: "exponential"
} | { stops
: [number, boolean][] ; type
: "interval"
}
Inherited from: Omit.textOptional
# textPadding
• Optional
textPadding: number | ExpressionSpecificationEx | { stops
: [number, number][] ; type
: "exponential"
} | { stops
: [number, number][] ; type
: "interval"
}
Inherited from: Omit.textPadding
# textPitchAlignment
• Optional
textPitchAlignment: "map"
| ExpressionSpecificationEx | "viewport"
| "auto"
| { stops
: [number, "map"
| "viewport"
| "auto"
][] ; type
: "exponential"
} | { stops
: [number, "map"
| "viewport"
| "auto"
][] ; type
: "interval"
}
Inherited from: Omit.textPitchAlignment
# 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"
}
Inherited from: Omit.textRadialOffset
# 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"
}
Inherited from: Omit.textRotate
# textRotationAlignment
• Optional
textRotationAlignment: "map"
| ExpressionSpecificationEx | "viewport"
| "auto"
| { stops
: [number, "map"
| "viewport"
| "auto"
][] ; type
: "exponential"
} | { stops
: [number, "map"
| "viewport"
| "auto"
][] ; type
: "interval"
}
Inherited from: Omit.textRotationAlignment
# 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"
}
Inherited from: Omit.textSize
# 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"
}
Inherited from: Omit.textTransform
# textTranslate
• Optional
textTranslate: [number, number] | ExpressionSpecificationEx | { stops
: [number, [number, number]][] ; type
: "exponential"
} | { stops
: [number, [number, number]][] ; type
: "interval"
}
Inherited from: Omit.textTranslate
# textTranslateAnchor
• Optional
textTranslateAnchor: "map"
| ExpressionSpecificationEx | "viewport"
| { stops
: [number, "map"
| "viewport"
][] ; type
: "exponential"
} | { stops
: [number, "map"
| "viewport"
][] ; type
: "interval"
}
Inherited from: Omit.textTranslateAnchor
# textVariableAnchor
• Optional
textVariableAnchor: ExpressionSpecificationEx | Anchor[] | { stops
: [number, Anchor[]][] ; type
: "exponential"
} | { stops
: [number, Anchor[]][] ; type
: "interval"
}
Inherited from: Omit.textVariableAnchor
# textWritingMode
• Optional
textWritingMode: ExpressionSpecificationEx | ("vertical"
| "horizontal"
)[] | { stops
: [number, ("vertical"
| "horizontal"
)[]][] ; type
: "exponential"
} | { stops
: [number, ("vertical"
| "horizontal"
)[]][] ; type
: "interval"
}
Inherited from: Omit.textWritingMode
# visibility
• Optional
visibility: "visible"
| "none"
Inherited from: Omit.visibility