Class TerraDrawCircleMode

Hierarchy (View Summary)

TerraDrawBaseDrawMode<CirclePolygonStyling>
- TerraDrawCircleMode

Constructors

constructor

new TerraDrawCircleMode(
options?: TerraDrawCircleModeOptions<CirclePolygonStyling>,
): TerraDrawCircleMode
Create a new circle mode instance
Parameters
- Optionaloptions: TerraDrawCircleModeOptions<CirclePolygonStyling>
  Options to customize the behavior of the circle mode
  - keyEvents
    Key events to cancel or finish the mode
  - cursors
    Cursors to use for the mode
  - styles
    Custom styling for the circle
  - pointerDistance
    Distance in pixels to consider a pointer close to a vertex
  - startingRadiusKilometers
    The starting radius of the circle in kilometers
  - projection
    The map projection being used
  - drawInteraction
    The type of draw interaction to use
Returns TerraDrawCircleMode
Overrides TerraDrawBaseDrawMode.constructor
- Defined in terra-draw/src/modes/circle/circle.mode.ts:100

Properties

`Protected`_state

_state: TerraDrawModeState = "unregistered"

`Protected`_styles

_styles: Partial<Styling> = {}

`Protected`behaviors

behaviors: TerraDrawModeBehavior[] = []

`Protected`coordinatePrecision

coordinatePrecision: number

mode

mode: string = "circle"

`Protected`onStyleChange

onStyleChange: StoreChangeHandler<TerraDrawOnChangeContext | undefined>

`Protected`pointerDistance

pointerDistance: number = 40

`Protected`pointerEvents

pointerEvents: PointerEvents = DefaultPointerEvents

`Protected`project

project: Project

`Protected`projection

projection: Projection = "web-mercator"

`Protected`setCursor

setCursor: SetCursor

`Protected`setDoubleClickToZoom

setDoubleClickToZoom: (enabled: boolean) => void

`Protected`store

store: TerraDrawGeoJSONStore

type

type: ModeTypes = ModeTypes.Drawing

`Protected` `Optional`undoRedoMaxStackSize

undoRedoMaxStackSize?: number

`Protected`unproject

unproject: Unproject

`Protected`validate

validate: Validation | undefined

Accessors

state

get state(): TerraDrawModeState
Returns TerraDrawModeState
Inherited from TerraDrawBaseDrawMode.state
- Defined in terra-draw/src/modes/base.mode.ts:73
set state(_: TerraDrawModeState): void
Parameters
- _: TerraDrawModeState
Returns void
Inherited from TerraDrawBaseDrawMode.state
- Defined in terra-draw/src/modes/base.mode.ts:76

styles

get styles(): Partial<Styling>
Returns Partial<Styling>
Inherited from TerraDrawBaseDrawMode.styles
- Defined in terra-draw/src/modes/base.mode.ts:82
set styles(styling: Partial<Styling>): void
Parameters
- styling: Partial<Styling>
Returns void
Inherited from TerraDrawBaseDrawMode.styles
- Defined in terra-draw/src/modes/base.mode.ts:85

Methods

afterFeatureAdded

afterFeatureAdded(feature: GeoJSONStoreFeatures): void
Parameters
- feature: GeoJSONStoreFeatures
Returns void
Inherited from TerraDrawBaseDrawMode.afterFeatureAdded
- Defined in terra-draw/src/modes/base.mode.ts:241

afterFeatureUpdated

afterFeatureUpdated(feature: GeoJSONStoreFeatures): void
Parameters
- feature: GeoJSONStoreFeatures
Returns void
Overrides TerraDrawBaseDrawMode.afterFeatureUpdated
- Defined in terra-draw/src/modes/circle/circle.mode.ts:455

`Protected`allowPointerEvent

allowPointerEvent(
pointerEvent: AllowPointerEvent,
event: TerraDrawMouseEvent,
): boolean
Parameters
- pointerEvent: AllowPointerEvent
- event: TerraDrawMouseEvent
Returns boolean
Inherited from TerraDrawBaseDrawMode.allowPointerEvent
- Defined in terra-draw/src/modes/base.mode.ts:159

cleanUp

cleanUp(): void
Internal
Returns void
Overrides TerraDrawBaseDrawMode.cleanUp
- Defined in terra-draw/src/modes/circle/circle.mode.ts:315

clearHistory

clearHistory(): void
Returns void
Inherited from TerraDrawBaseDrawMode.clearHistory
- Defined in terra-draw/src/modes/base.mode.ts:315

`Protected`getHexColorStylingValue

getHexColorStylingValue(
    value:
        | `#${string}`
        | ((feature: GeoJSONStoreFeatures) => `#${string}` | undefined)
        | undefined,
    defaultValue: `#${string}`,
    feature: GeoJSONStoreFeatures,
): `#${string}`
Parameters
- value:
      | `#${string}`
      | ((feature: GeoJSONStoreFeatures) => `#${string}` | undefined)
      | undefined
- defaultValue: `#${string}`
- feature: GeoJSONStoreFeatures
Returns `#${string}`
Inherited from TerraDrawBaseDrawMode.getHexColorStylingValue
- Defined in terra-draw/src/modes/base.mode.ts:338

`Protected`getNumericStylingValue

getNumericStylingValue(
    value:
        | number
        | ((feature: GeoJSONStoreFeatures) => number | undefined)
        | undefined,
    defaultValue: number,
    feature: GeoJSONStoreFeatures,
): number
Parameters
- value: number | ((feature: GeoJSONStoreFeatures) => number | undefined) | undefined
- defaultValue: number
- feature: GeoJSONStoreFeatures
Returns number
Inherited from TerraDrawBaseDrawMode.getNumericStylingValue
- Defined in terra-draw/src/modes/base.mode.ts:349

`Protected`getUrlStylingValue

getUrlStylingValue(
    value: UrlStyling | undefined,
    defaultValue: string,
    feature: GeoJSONStoreFeatures,
): string
Parameters
- value: UrlStyling | undefined
- defaultValue: string
- feature: GeoJSONStoreFeatures
Returns string
Inherited from TerraDrawBaseDrawMode.getUrlStylingValue
- Defined in terra-draw/src/modes/base.mode.ts:360

onClick

onClick(event: TerraDrawMouseEvent): void
Internal
Parameters
- event: TerraDrawMouseEvent
Returns void
Overrides TerraDrawBaseDrawMode.onClick
- Defined in terra-draw/src/modes/circle/circle.mode.ts:223

onDeselect

onDeselect(deselectedId: FeatureId): void
Parameters
- deselectedId: FeatureId
Returns void
Inherited from TerraDrawBaseDrawMode.onDeselect
- Defined in terra-draw/src/modes/base.mode.ts:310

onDrag

onDrag(
event: TerraDrawMouseEvent,
setMapDraggability: (enabled: boolean) => void,
): void
Internal
Parameters
- event: TerraDrawMouseEvent
- setMapDraggability: (enabled: boolean) => void
Returns void
Overrides TerraDrawBaseDrawMode.onDrag
- Defined in terra-draw/src/modes/circle/circle.mode.ts:282

onDragEnd

onDragEnd(
event: TerraDrawMouseEvent,
setMapDraggability: (enabled: boolean) => void,
): void
Internal
Parameters
- event: TerraDrawMouseEvent
- setMapDraggability: (enabled: boolean) => void
Returns void
Overrides TerraDrawBaseDrawMode.onDragEnd
- Defined in terra-draw/src/modes/circle/circle.mode.ts:298

onDragStart

onDragStart(
event: TerraDrawMouseEvent,
setMapDraggability: (enabled: boolean) => void,
): void
Internal
Parameters
- event: TerraDrawMouseEvent
- setMapDraggability: (enabled: boolean) => void
Returns void
Overrides TerraDrawBaseDrawMode.onDragStart
- Defined in terra-draw/src/modes/circle/circle.mode.ts:264

onFinish

onFinish(finishedId: FeatureId, context: OnFinishContext): void
Parameters
- finishedId: FeatureId
- context: OnFinishContext
Returns void
Inherited from TerraDrawBaseDrawMode.onFinish
- Defined in terra-draw/src/modes/base.mode.ts:309

onSelect

onSelect(selectedId: FeatureId): void
Parameters
- selectedId: FeatureId
Returns void
Inherited from TerraDrawBaseDrawMode.onSelect
- Defined in terra-draw/src/modes/base.mode.ts:311

redo

redo(): void
Returns void
Inherited from TerraDrawBaseDrawMode.redo
- Defined in terra-draw/src/modes/base.mode.ts:322

redoSize

redoSize(): number
Returns number
Inherited from TerraDrawBaseDrawMode.redoSize
- Defined in terra-draw/src/modes/base.mode.ts:319

register

register(config: TerraDrawModeRegisterConfig): void
Parameters
- config: TerraDrawModeRegisterConfig
Returns void
Inherited from TerraDrawBaseDrawMode.register
- Defined in terra-draw/src/modes/base.mode.ts:206

registerBehaviors

registerBehaviors(config: BehaviorConfig): void
Parameters
- config: BehaviorConfig
Returns void
Overrides TerraDrawBaseDrawMode.registerBehaviors
- Defined in terra-draw/src/modes/circle/circle.mode.ts:469

`Protected`setDrawing

setDrawing(): void
Returns void
Inherited from TerraDrawBaseDrawMode.setDrawing
- Defined in terra-draw/src/modes/base.mode.ts:175

`Protected`setStarted

setStarted(): void
Returns void
Inherited from TerraDrawBaseDrawMode.setStarted
- Defined in terra-draw/src/modes/base.mode.ts:183

`Protected`setStopped

setStopped(): void
Returns void
Inherited from TerraDrawBaseDrawMode.setStopped
- Defined in terra-draw/src/modes/base.mode.ts:197

start

start(): void
Internal
Returns void
Overrides TerraDrawBaseDrawMode.start
- Defined in terra-draw/src/modes/circle/circle.mode.ts:210

stop

stop(): void
Internal
Returns void
Overrides TerraDrawBaseDrawMode.stop
- Defined in terra-draw/src/modes/circle/circle.mode.ts:216

styleFeature

styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling
Internal
Parameters
- feature: GeoJSONStoreFeatures
Returns TerraDrawAdapterStyling
Overrides TerraDrawBaseDrawMode.styleFeature
- Defined in terra-draw/src/modes/circle/circle.mode.ts:330

undo

undo(): void
Returns void
Inherited from TerraDrawBaseDrawMode.undo
- Defined in terra-draw/src/modes/base.mode.ts:314

undoSize

undoSize(): number
Returns number
Inherited from TerraDrawBaseDrawMode.undoSize
- Defined in terra-draw/src/modes/base.mode.ts:316

updateOptions

updateOptions(
    options?: ModeUpdateOptions<
        TerraDrawCircleModeOptions<CirclePolygonStyling>,
    >,
): void
Parameters
- Optionaloptions: ModeUpdateOptions<TerraDrawCircleModeOptions<CirclePolygonStyling>>
Returns void
Overrides TerraDrawBaseDrawMode.updateOptions
- Defined in terra-draw/src/modes/circle/circle.mode.ts:105

validateFeature

validateFeature(feature: unknown): StoreValidation
Parameters
- feature: unknown
Returns StoreValidation
Overrides TerraDrawBaseDrawMode.validateFeature
- Defined in terra-draw/src/modes/circle/circle.mode.ts:376

`Protected`validateModeFeature

validateModeFeature(
    feature: unknown,
    modeValidationFn: (
        feature: GeoJSONStoreFeatures,
    ) => { reason?: string; valid: boolean },
): { reason?: string; valid: boolean }
Parameters
- feature: unknown
- modeValidationFn: (feature: GeoJSONStoreFeatures) => { reason?: string; valid: boolean }
Returns { reason?: string; valid: boolean }
Inherited from TerraDrawBaseDrawMode.validateModeFeature
- Defined in terra-draw/src/modes/base.mode.ts:280

Class TerraDrawCircleMode

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

keyEvents

cursors

styles

pointerDistance

startingRadiusKilometers

projection

drawInteraction

Returns TerraDrawCircleMode

Properties

Protected_state

Protected_styles

Protectedbehaviors

ProtectedcoordinatePrecision

mode

ProtectedonStyleChange

ProtectedpointerDistance

ProtectedpointerEvents

Protectedproject

Protectedprojection

ProtectedsetCursor

ProtectedsetDoubleClickToZoom

Protectedstore

type

Protected OptionalundoRedoMaxStackSize

Protectedunproject

Protectedvalidate

Accessors

state

Returns TerraDrawModeState

Parameters

Returns void

styles

Returns Partial<Styling>

Parameters

Returns void

Methods

afterFeatureAdded

Parameters

Returns void

afterFeatureUpdated

Parameters

Returns void

ProtectedallowPointerEvent

Parameters

Returns boolean

cleanUp

Returns void

clearHistory

Returns void

ProtectedgetHexColorStylingValue

Parameters

Returns `#${string}`

ProtectedgetNumericStylingValue

Parameters

Returns number

ProtectedgetUrlStylingValue

Parameters

Returns string

onClick

Parameters

Returns void

onDeselect

Parameters

Returns void

onDrag

Parameters

Returns void

onDragEnd

Parameters

Returns void

`Protected`_state

`Protected`_styles

`Protected`behaviors

`Protected`coordinatePrecision

`Protected`onStyleChange

`Protected`pointerDistance

`Protected`pointerEvents

`Protected`project

`Protected`projection

`Protected`setCursor

`Protected`setDoubleClickToZoom

`Protected`store

`Protected` `Optional`undoRedoMaxStackSize

`Protected`unproject

`Protected`validate

`Protected`allowPointerEvent

`Protected`getHexColorStylingValue

`Protected`getNumericStylingValue

`Protected`getUrlStylingValue

`Protected`setDrawing

`Protected`setStarted

`Protected`setStopped

`Protected`validateModeFeature