Class TerraDrawPolygonMode

Hierarchy (View Summary)

TerraDrawBaseDrawMode<PolygonStyling>
- TerraDrawPolygonMode

Constructors

constructor

new TerraDrawPolygonMode(
options?: TerraDrawPolygonModeOptions<PolygonStyling>,
): TerraDrawPolygonMode
Parameters
- Optionaloptions: TerraDrawPolygonModeOptions<PolygonStyling>
Returns TerraDrawPolygonMode
Overrides TerraDrawBaseDrawMode.constructor
- Defined in terra-draw/src/modes/polygon/polygon.mode.ts:127

Properties

`Protected`_state

_state: TerraDrawModeState = "unregistered"

`Protected`_styles

_styles: Partial<Styling> = {}

`Protected`behaviors

behaviors: TerraDrawModeBehavior[] = []

`Protected`coordinatePrecision

coordinatePrecision: number

mode

mode: string = "polygon"

`Protected`onStyleChange

onStyleChange: StoreChangeHandler<OnChangeContext | 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`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
Overrides TerraDrawBaseDrawMode.afterFeatureAdded
- Defined in terra-draw/src/modes/polygon/polygon.mode.ts:1244

afterFeatureUpdated

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

`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:156

cleanUp

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

`Protected`getHexColorStylingValue

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

`Protected`getNumericStylingValue

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

`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:338

onClick

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

onDeselect

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

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/polygon/polygon.mode.ts:922

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/polygon/polygon.mode.ts:1046

onDragStart

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

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:302

onSelect

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

register

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

registerBehaviors

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

`Protected`setDrawing

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

`Protected`setStarted

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

`Protected`setStopped

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

start

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

stop

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

styleFeature

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

updateOptions

updateOptions(
options?: ModeUpdateOptions<TerraDrawPolygonModeOptions<PolygonStyling>>,
): void
Parameters
- Optionaloptions: ModeUpdateOptions<TerraDrawPolygonModeOptions<PolygonStyling>>
Returns void
Overrides TerraDrawBaseDrawMode.updateOptions
- Defined in terra-draw/src/modes/polygon/polygon.mode.ts:132

validateFeature

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

`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:273

Class TerraDrawPolygonMode

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TerraDrawPolygonMode

Properties

Protected_state

Protected_styles

Protectedbehaviors

ProtectedcoordinatePrecision

mode

ProtectedonStyleChange

ProtectedpointerDistance

ProtectedpointerEvents

Protectedproject

Protectedprojection

ProtectedsetCursor

ProtectedsetDoubleClickToZoom

Protectedstore

type

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

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

onDragStart

Parameters

Returns void

onFinish

Parameters

Returns void

onKeyDown

Returns void

onKeyUp

Parameters

`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`unproject

`Protected`validate

`Protected`allowPointerEvent

`Protected`getHexColorStylingValue

`Protected`getNumericStylingValue

`Protected`getUrlStylingValue

`Protected`setDrawing

`Protected`setStarted

`Protected`setStopped

`Protected`validateModeFeature