---
title: Interface: CircleOptions
source: https://vjmap.com/en/doc/Interface_CircleOptions.html
---

# Interface: CircleOptions

[default](#modulesdefaultmd).CircleOptions

### Hierarchy

- [*OverlayLayerBaseOptions*](#interfacesdefaultoverlaylayerbaseoptionsmd)

  ↳ **CircleOptions**

### Table of contents

#### Properties

- [circleBlur](#circleblur)
- [circleColor](#circlecolor)
- [circleOpacity](#circleopacity)
- [circlePitchAlignment](#circlepitchalignment)
- [circlePitchScale](#circlepitchscale)
- [circleRadius](#circleradius)
- [circleSortKey](#circlesortkey)
- [circleStrokeColor](#circlestrokecolor)
- [circleStrokeOpacity](#circlestrokeopacity)
- [circleStrokeWidth](#circlestrokewidth)
- [circleTranslate](#circletranslate)
- [circleTranslateAnchor](#circletranslateanchor)
- [data](#data)
- [filter](#filter)
- [isHoverFeatureState](#ishoverfeaturestate)
- [isHoverPointer](#ishoverpointer)
- [layerId](#layerid)
- [maxzoom](#maxzoom)
- [minzoom](#minzoom)
- [sourceId](#sourceid)
- [sourceLayer](#sourcelayer)
- [visibility](#visibility)

### Properties

#### circleBlur

• `Optional` **circleBlur**: *number* \| [*ExpressionSpecificationEx*](#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*](#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*](#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*](#expressionspecificationex) \| ``"viewport"`` \| { `stops`: [*number*, ``"map"`` \| ``"viewport"``][] ; `type`: ``"exponential"``  } \| { `stops`: [*number*, ``"map"`` \| ``"viewport"``][] ; `type`: ``"interval"``  }

___

#### circlePitchScale

• `Optional` **circlePitchScale**: ``"map"`` \| [*ExpressionSpecificationEx*](#expressionspecificationex) \| ``"viewport"`` \| { `stops`: [*number*, ``"map"`` \| ``"viewport"``][] ; `type`: ``"exponential"``  } \| { `stops`: [*number*, ``"map"`` \| ``"viewport"``][] ; `type`: ``"interval"``  }

___

#### circleRadius

• `Optional` **circleRadius**: *number* \| [*ExpressionSpecificationEx*](#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*](#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*](#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*](#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*](#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*](#expressionspecificationex) \| { `stops`: [*number*, [*number*, *number*]][] ; `type`: ``"exponential"``  } \| { `stops`: [*number*, [*number*, *number*]][] ; `type`: ``"interval"``  }

___

#### circleTranslateAnchor

• `Optional` **circleTranslateAnchor**: ``"map"`` \| [*ExpressionSpecificationEx*](#expressionspecificationex) \| ``"viewport"`` \| { `stops`: [*number*, ``"map"`` \| ``"viewport"``][] ; `type`: ``"exponential"``  } \| { `stops`: [*number*, ``"map"`` \| ``"viewport"``][] ; `type`: ``"interval"``  }

___

#### data

• **data**: *any*

___

#### filter

• `Optional` **filter**: *any*

Inherited from: [OverlayLayerBaseOptions](#interfacesdefaultoverlaylayerbaseoptionsmd).[filter](#filter)

___

#### isHoverFeatureState

• `Optional` **isHoverFeatureState**: *boolean*

Inherited from: [OverlayLayerBaseOptions](#interfacesdefaultoverlaylayerbaseoptionsmd).[isHoverFeatureState](#ishoverfeaturestate)

___

#### isHoverPointer

• `Optional` **isHoverPointer**: *boolean*

Inherited from: [OverlayLayerBaseOptions](#interfacesdefaultoverlaylayerbaseoptionsmd).[isHoverPointer](#ishoverpointer)

___

#### layerId

• `Optional` **layerId**: *string*

Inherited from: [OverlayLayerBaseOptions](#interfacesdefaultoverlaylayerbaseoptionsmd).[layerId](#layerid)

___

#### maxzoom

• `Optional` **maxzoom**: *number*

Inherited from: [OverlayLayerBaseOptions](#interfacesdefaultoverlaylayerbaseoptionsmd).[maxzoom](#maxzoom)

___

#### minzoom

• `Optional` **minzoom**: *number*

Inherited from: [OverlayLayerBaseOptions](#interfacesdefaultoverlaylayerbaseoptionsmd).[minzoom](#minzoom)

___

#### sourceId

• `Optional` **sourceId**: *string*

Inherited from: [OverlayLayerBaseOptions](#interfacesdefaultoverlaylayerbaseoptionsmd).[sourceId](#sourceid)

___

#### sourceLayer

• `Optional` **sourceLayer**: *string*

Inherited from: [OverlayLayerBaseOptions](#interfacesdefaultoverlaylayerbaseoptionsmd).[sourceLayer](#sourcelayer)

___

#### visibility

• `Optional` **visibility**: ``"visible"`` \| ``"none"``

Inherited from: [OverlayLayerBaseOptions](#interfacesdefaultoverlaylayerbaseoptionsmd).[visibility](#visibility)


<a name="interfacesdefaultconfigmd"></a>

[vjmap](#readmemd) / [Exports](#modulesmd) / [default](#modulesdefaultmd) / Config