Class InteractiveAnnotation

Represents an InteractiveAnnotation.

Hierarchy

InteractiveAnnotation

Implements

IInteractiveAnnotation

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new InteractiveAnnotation(properties?: IInteractiveAnnotation): InteractiveAnnotation

- Defined in WAProto/index.d.ts:7843
Constructs a new InteractiveAnnotation.

Parameters
- Optional properties: IInteractiveAnnotation
Returns InteractiveAnnotation

Properties

Optional action

action: "location"

InteractiveAnnotation action.

Optional location

location: ILocation

InteractiveAnnotation location.

polygonVertices

polygonVertices: IPoint[]

InteractiveAnnotation polygonVertices.

Methods

toJSON

toJSON(): {}

- Defined in WAProto/index.d.ts:7928
Converts this InteractiveAnnotation to JSON.

Returns {}

JSON object
- [k: string]: any

Static create

create(properties?: IInteractiveAnnotation): InteractiveAnnotation

- Defined in WAProto/index.d.ts:7865
Creates a new InteractiveAnnotation instance using the specified properties.

Parameters
- Optional properties: IInteractiveAnnotation
Returns InteractiveAnnotation

InteractiveAnnotation instance

Static decode

decode(reader: Uint8Array | Reader, length?: number): InteractiveAnnotation

- Defined in WAProto/index.d.ts:7891
Decodes an InteractiveAnnotation message from the specified reader or buffer.

throws

{Error} If the payload is not a reader or valid buffer

throws

{$protobuf.util.ProtocolError} If required fields are missing

Parameters
- reader: Uint8Array | Reader
  
  Reader or buffer to decode from
- Optional length: number
Returns InteractiveAnnotation

InteractiveAnnotation

Static decodeDelimited

decodeDelimited(reader: Uint8Array | Reader): InteractiveAnnotation

- Defined in WAProto/index.d.ts:7900
Decodes an InteractiveAnnotation message from the specified reader or buffer, length delimited.

throws

{Error} If the payload is not a reader or valid buffer

throws

{$protobuf.util.ProtocolError} If required fields are missing

Parameters
- reader: Uint8Array | Reader
  
  Reader or buffer to decode from
Returns InteractiveAnnotation

InteractiveAnnotation

Static encode

encode(message: IInteractiveAnnotation, writer?: Writer): Writer

- Defined in WAProto/index.d.ts:7873
Encodes the specified InteractiveAnnotation message. Does not implicitly verify messages.

Parameters
- message: IInteractiveAnnotation
  
  InteractiveAnnotation message or plain object to encode
- Optional writer: Writer
Returns Writer

Writer

Static encodeDelimited

encodeDelimited(message: IInteractiveAnnotation, writer?: Writer): Writer

- Defined in WAProto/index.d.ts:7881
Encodes the specified InteractiveAnnotation message, length delimited. Does not implicitly verify messages.

Parameters
- message: IInteractiveAnnotation
  
  InteractiveAnnotation message or plain object to encode
- Optional writer: Writer
Returns Writer

Writer

Static fromObject

fromObject(object: {}): InteractiveAnnotation

- Defined in WAProto/index.d.ts:7914
Creates an InteractiveAnnotation message from a plain object. Also converts values to their respective internal types.

Parameters
- object: {}
  
  Plain object
  - [k: string]: any
Returns InteractiveAnnotation

InteractiveAnnotation

Static toObject

toObject(message: InteractiveAnnotation, options?: IConversionOptions): {}

- Defined in WAProto/index.d.ts:7922
Creates a plain object from an InteractiveAnnotation message. Also converts values to other types if specified.

Parameters
- message: InteractiveAnnotation
  
  InteractiveAnnotation
- Optional options: IConversionOptions
Returns {}

Plain object
- [k: string]: any

Static verify

verify(message: {}): string

- Defined in WAProto/index.d.ts:7907
Verifies an InteractiveAnnotation message.

Parameters
- message: {}
  
  Plain object to verify
  - [k: string]: any
Returns string

null if valid, otherwise the reason why it is not

Generated using TypeDoc