PanelPayload | geoview-core

Class definition for PanelPayload

exports

Hierarchy

PayloadBaseClass
- PanelPayload

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PanelPayload(event: EventStringId, handlerName: null | string): PanelPayload

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

Parameters
- event: EventStringId
  
  the event identifier for which the payload is constructed
- handlerName: null | string
  
  the handler Name
Returns PanelPayload

Properties

event

event: EventStringId

handlerName

handlerName: null | string

Methods

Static withButtonIdAndActionButton

withButtonIdAndActionButton(event: EventStringId, handlerName: null | string, buttonId: string, actionButton: TypeActionButton): PanelAndActionPayload

- Defined in packages/geoview-core/src/api/events/payloads/panel-payload.ts:163
Static method used to create a panel payload with additional buton ID and action buton information

Parameters
- event: EventStringId
  
  the event identifier for which the payload is constructed
- handlerName: null | string
  
  the handler Name
- buttonId: string
  
  the panel buton id
- actionButton: TypeActionButton
  
  the action buton information
Returns PanelAndActionPayload
the PanelAndActionPayload object created

Static withButtonIdAndContent

withButtonIdAndContent(event: EventStringId, handlerName: null | string, buttonId: string, content: Element | ReactNode): PanelAndContentPayload

- Defined in packages/geoview-core/src/api/events/payloads/panel-payload.ts:186
Static method used to create a panel payload with additional buton ID and content information

Parameters
- event: EventStringId
  
  the event identifier for which the payload is constructed
- handlerName: null | string
  
  the handler Name
- buttonId: string
  
  the panel buton id
- content: Element | ReactNode
  
  the content object
Returns PanelAndContentPayload
the PanelAndContentPayload object created

Static withButtonIdAndType

withButtonIdAndType(event: EventStringId, handlerName: null | string, buttonId: string, type: string): PanelWithAButtonIdAndTypePayload

- Defined in packages/geoview-core/src/api/events/payloads/panel-payload.ts:140
Static method used to create a panel payload with additional buton ID and panel type information

Parameters
- event: EventStringId
  
  the event identifier for which the payload is constructed
- handlerName: null | string
  
  the handler Name
- buttonId: string
  
  the panel buton id
- type: string
  
  the panel type
Returns PanelWithAButtonIdAndTypePayload
the PanelWithAButtonIdAndTypePayload object created

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

event: EventStringId

handlerName: null | string

Returns PanelPayload

Properties

event

handlerName

Methods

Static withButtonIdAndActionButton

Parameters

event: EventStringId

handlerName: null | string

buttonId: string

actionButton: TypeActionButton

Returns PanelAndActionPayload

Static withButtonIdAndContent

Parameters

event: EventStringId

handlerName: null | string

buttonId: string

content: Element | ReactNode

Returns PanelAndContentPayload

Static withButtonIdAndType

Parameters

event: EventStringId

handlerName: null | string

buttonId: string

type: string

Returns PanelWithAButtonIdAndTypePayload