Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VectorConfigPayload

Class definition for VectorConfigPayload

exports

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

event

event: EventStringId

handlerName

handlerName: null | string

Optional id

id?: string

type

type: TypeOfVector

Methods

Static forCircle

  • forCircle(event: EventStringId, handlerName: null | string, coordinate: Coordinate, radius?: number, options?: { geometryLayout?: "XY" | "XYZ" | "XYM" | "XYZM"; style?: TypeFeatureCircleStyle }, id?: string): CircleConfigPayload

  • Static method used to create a CircleConfigPayload

    Parameters

    • event: EventStringId

      the event identifier for which the payload is constructed

    • handlerName: null | string

      the handler Name

    • coordinate: Coordinate

      the long lat coordintate

    • Optional radius: number

      optional circle radius

    • Optional options: { geometryLayout?: "XY" | "XYZ" | "XYM" | "XYZM"; style?: TypeFeatureCircleStyle }

      the circle options

    • Optional id: string

      optional circle identifier

    Returns CircleConfigPayload

    the CircleConfigPayload object created

Static forCircleMarker

  • forCircleMarker(event: EventStringId, handlerName: null | string, coordinate: Coordinate, radius?: number, options?: { geometryLayout?: "XY" | "XYZ" | "XYM" | "XYZM"; style?: TypeFeatureCircleStyle }, id?: string): CircleMarkerConfigPayload

  • Static method used to create a CircleMarkerConfigPayload

    Parameters

    • event: EventStringId

      the event identifier for which the payload is constructed

    • handlerName: null | string

      the handler Name

    • coordinate: Coordinate

      the circle marker long lat position

    • Optional radius: number

      optional circle marker radius

    • Optional options: { geometryLayout?: "XY" | "XYZ" | "XYM" | "XYZM"; style?: TypeFeatureCircleStyle }

      the circle marker options

    • Optional id: string

      optional circle marker identifier

    Returns CircleMarkerConfigPayload

    the CircleMarkerConfigPayload object created

Static forMarker

  • forMarker(event: EventStringId, handlerName: null | string, coordinate: Coordinate, options?: { geometryLayout?: "XY" | "XYZ" | "XYM" | "XYZM"; style?: TypeFeatureStyle }, id?: string): MarkerConfigPayload

  • Static method used to create a MarkerConfigPayload

    Parameters

    • event: EventStringId

      the event identifier for which the payload is constructed

    • handlerName: null | string

      the handler Name

    • coordinate: Coordinate

      the marker long lat position

    • Optional options: { geometryLayout?: "XY" | "XYZ" | "XYM" | "XYZM"; style?: TypeFeatureStyle }

      the marker options

      • Optional geometryLayout?: "XY" | "XYZ" | "XYM" | "XYZM"
      • Optional style?: TypeFeatureStyle
    • Optional id: string

      optional marker identifier

    Returns MarkerConfigPayload

    the MarkerConfigPayload object created

Static forPolygon

  • forPolygon(event: EventStringId, handlerName: null | string, points: Coordinate, options: { geometryLayout?: "XY" | "XYZ" | "XYM" | "XYZM"; style?: TypeFeatureStyle }, id?: string): PolygonConfigPayload

Static forPolyline

  • forPolyline(event: EventStringId, handlerName: null | string, points: Coordinate, options: { geometryLayout?: "XY" | "XYZ" | "XYM" | "XYZM"; style?: TypeFeatureStyle }, id?: string): PolylineConfigPayload

Generated using TypeDoc