# Interface: CircleOptions
default.CircleOptions
# Hierarchy
-
↳ CircleOptions
# Table of contents
# Properties
- circleBlur
- circleColor
- circleOpacity
- circlePitchAlignment
- circlePitchScale
- circleRadius
- circleSortKey
- circleStrokeColor
- circleStrokeOpacity
- circleStrokeWidth
- circleTranslate
- circleTranslateAnchor
- data
- filter
- isHoverFeatureState
- isHoverPointer
- layerId
- maxzoom
- minzoom
- sourceId
- sourceLayer
- visibility
# Properties
# circleBlur
• Optional
circleBlur: 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"
}
# circleColor
• Optional
circleColor: 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"
}
# circleOpacity
• Optional
circleOpacity: 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"
}
# circlePitchAlignment
• Optional
circlePitchAlignment: "map"
| ExpressionSpecificationEx | "viewport"
| { stops
: [number, "map"
| "viewport"
][] ; type
: "exponential"
} | { stops
: [number, "map"
| "viewport"
][] ; type
: "interval"
}
# circlePitchScale
• Optional
circlePitchScale: "map"
| ExpressionSpecificationEx | "viewport"
| { stops
: [number, "map"
| "viewport"
][] ; type
: "exponential"
} | { stops
: [number, "map"
| "viewport"
][] ; type
: "interval"
}
# circleRadius
• Optional
circleRadius: 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"
}
# circleSortKey
• Optional
circleSortKey: 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"
}
# circleStrokeColor
• Optional
circleStrokeColor: 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"
}
# circleStrokeOpacity
• Optional
circleStrokeOpacity: 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"
}
# circleStrokeWidth
• Optional
circleStrokeWidth: 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"
}
# circleTranslate
• Optional
circleTranslate: [number, number] | ExpressionSpecificationEx | { stops
: [number, [number, number]][] ; type
: "exponential"
} | { stops
: [number, [number, number]][] ; type
: "interval"
}
# circleTranslateAnchor
• Optional
circleTranslateAnchor: "map"
| ExpressionSpecificationEx | "viewport"
| { stops
: [number, "map"
| "viewport"
][] ; type
: "exponential"
} | { stops
: [number, "map"
| "viewport"
][] ; type
: "interval"
}
# data
• data: any
# filter
• Optional
filter: any
Inherited from: OverlayLayerBaseOptions.filter
# 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
# visibility
• Optional
visibility: "visible"
| "none"
Inherited from: OverlayLayerBaseOptions.visibility