Class VectorPayload

Class definition for VectorPayload

exports

Hierarchy

PayloadBaseClass
- VectorPayload

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new VectorPayload(event: EventStringId, handlerName: null | string, type: TypeOfVector): VectorPayload

Overrides PayloadBaseClass.constructor
- Defined in packages/geoview-core/src/api/events/payloads/vector-payload.ts:151
Constructor for the class

Parameters
- event: EventStringId
  
  the event identifier for which the payload is constructed
- handlerName: null | string
  
  the handler Name
- type: TypeOfVector
  
  the type of vector object that makes up the payload
Returns VectorPayload

Properties

event

event: EventStringId

handlerName

handlerName: null | string

type

type: TypeOfVector

Methods

Static forCircle

forCircle(event: EventStringId, handlerName: null | string, circle: Feature<Geometry>): CirclePayload

- Defined in packages/geoview-core/src/api/events/payloads/vector-payload.ts:166
Static method used to create a CirclePayload

Parameters
- event: EventStringId
  
  the event identifier for which the payload is constructed
- handlerName: null | string
  
  the handler Name
- circle: Feature<Geometry>
  
  the circle payload
Returns CirclePayload
the CirclePayload object created

Static forCircleMarker

forCircleMarker(event: EventStringId, handlerName: null | string, circleMarker: Feature<Geometry>): CircleMarkerPayload

- Defined in packages/geoview-core/src/api/events/payloads/vector-payload.ts:181
Static method used to create a CircleMarkerPayload

Parameters
- event: EventStringId
  
  the event identifier for which the payload is constructed
- handlerName: null | string
  
  the handler Name
- circleMarker: Feature<Geometry>
  
  the circle marker payload
Returns CircleMarkerPayload
the CircleMarkerPayload object created

Static forMarker

forMarker(event: EventStringId, handlerName: null | string, marker: Feature<Geometry>): MarkerPayload

- Defined in packages/geoview-core/src/api/events/payloads/vector-payload.ts:196
Static method used to create a MarkerPayload

Parameters
- event: EventStringId
  
  the event identifier for which the payload is constructed
- handlerName: null | string
  
  the handler Name
- marker: Feature<Geometry>
  
  the marker payload
Returns MarkerPayload
the MarkerPayload object created

Static forPolygon

forPolygon(event: EventStringId, handlerName: null | string, polygon: Feature<Geometry>): PolygonPayload

- Defined in packages/geoview-core/src/api/events/payloads/vector-payload.ts:211
Static method used to create a PolygonPayload

Parameters
- event: EventStringId
  
  the event identifier for which the payload is constructed
- handlerName: null | string
  
  the handler Name
- polygon: Feature<Geometry>
  
  the polygon payload
Returns PolygonPayload
the PolygonPayload object created

Static forPolyline

forPolyline(event: EventStringId, handlerName: null | string, polyline: Feature<Geometry>): PolylinePayload

- Defined in packages/geoview-core/src/api/events/payloads/vector-payload.ts:226
Static method used to create a PolylinePayload

Parameters
- event: EventStringId
  
  the event identifier for which the payload is constructed
- handlerName: null | string
  
  the handler Name
- polyline: Feature<Geometry>
  
  the polyline payload
Returns PolylinePayload
the PolylinePayload object created

Generated using TypeDoc