CitraClient.Schemas.RegionPolygon (citra_client v0.3.0)

View Source

Polygon region overlay

Fields

  • :color — String.t()
  • :label — String.t()
  • :x_coords — list of number() (API key: xCoords)
  • :y_coords — list of number() (API key: yCoords)

Summary

Types

t()

Functions

from_api(data)

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

to_api(struct)

Convert this struct into a map with the API's camelCase keys, ready to be JSON-encoded. Fields whose value is nil are omitted.

Types

t()

@type t() :: %CitraClient.Schemas.RegionPolygon{
  color: String.t() | nil,
  label: String.t() | nil,
  x_coords: [number() | nil],
  y_coords: [number() | nil]
}

Functions

from_api(data)

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

to_api(struct)

Convert this struct into a map with the API's camelCase keys, ready to be JSON-encoded. Fields whose value is nil are omitted.