Class InteractiveAnnotation

Represents an InteractiveAnnotation.

Hierarchy

  • InteractiveAnnotation

Implements

Constructors

Properties

action?: "location" | "newsletter"

InteractiveAnnotation action.

location?: null | ILocation

InteractiveAnnotation location.

InteractiveAnnotation newsletter.

polygonVertices: IPoint[]

InteractiveAnnotation polygonVertices.

shouldSkipConfirmation: boolean

InteractiveAnnotation shouldSkipConfirmation.

Methods

  • Converts this InteractiveAnnotation to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any
  • Decodes an InteractiveAnnotation message from the specified reader or buffer.

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

      Message length if known beforehand

    Returns InteractiveAnnotation

    InteractiveAnnotation

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

  • Decodes an InteractiveAnnotation message from the specified reader or buffer, length delimited.

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns InteractiveAnnotation

    InteractiveAnnotation

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

  • Encodes the specified InteractiveAnnotation message. Does not implicitly verify messages.

    Parameters

    • message: IInteractiveAnnotation

      InteractiveAnnotation message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

  • 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

      Writer to encode to

    Returns Writer

    Writer

  • Creates an InteractiveAnnotation message from a plain object. Also converts values to their respective internal types.

    Parameters

    • object: {
          [k: string]: any;
      }

      Plain object

      • [k: string]: any

    Returns InteractiveAnnotation

    InteractiveAnnotation

  • Creates a plain object from an InteractiveAnnotation message. Also converts values to other types if specified.

    Parameters

    • message: InteractiveAnnotation

      InteractiveAnnotation

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any
  • Verifies an InteractiveAnnotation message.

    Parameters

    • message: {
          [k: string]: any;
      }

      Plain object to verify

      • [k: string]: any

    Returns null | string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc