Struct GridRectangleRequest 

pub struct GridRectangleRequest {

    pub lower_left_x: u16,
    pub lower_left_y: u16,
    pub upper_right_x: u16,
    pub upper_right_y: u16,
    pub max_width: u32,
    pub max_height: u32,
    pub missing_map_tile_color: Option<String>,
    pub missing_region_color: Option<String>,
    pub format: OutputFormat,
    pub draw_region_rectangles: bool,
    pub draw_region_names: bool,
    pub draw_region_coordinates: bool,
    pub region_label_font_id: Option<String>,
    pub save_to: Option<String>,
    pub glw: Option<GlwRenderOptions>,
    pub labels: Vec<TextLabel>,
    pub logos: Vec<LogoPlacement>,
    pub groups: Vec<Vec<String>>,
}

Body of POST /api/render/grid-rectangle (JSON).

Fields

lower_left_x: u16

lower-left x grid coordinate.

lower_left_y: u16

lower-left y grid coordinate.

upper_right_x: u16

upper-right x grid coordinate.

upper_right_y: u16

upper-right y grid coordinate.

max_width: u32

max output width in pixels.

max_height: u32

max output height in pixels.

missing_map_tile_color: Option<String>

optional hex colour string for missing map tiles.

missing_region_color: Option<String>

optional hex colour string for missing regions.

format: OutputFormat

output format.

draw_region_rectangles: bool

draw a hairline rectangle around each region.

draw_region_names: bool

draw each region’s name in its lower-left corner.

draw_region_coordinates: bool

draw each region’s (x, y) grid coordinates above its name.

region_label_font_id: Option<String>

id of the font to draw region names / coordinates with. Required only when one of those overlays is enabled; must match a GET /api/fonts id.

save_to: Option<String>

destination for the saved render. Defaults to the user’s personal library. Format: "personal" or "group:<uuid>".

glw: Option<GlwRenderOptions>

optional GLW (GlobalWind) wind / current / wave overlay. The auto-saved GLW row inherits this render’s save_to destination.

labels: Vec<TextLabel>

zero or more free-floating text labels to draw in placement slots (independent of the GLW overlay).

logos: Vec<LogoPlacement>

zero or more logo images to composite in placement slots.

groups: Vec<Vec<String>>

user-defined combined slot groups (each a list of slot-anchor names), used only by the placement-slots endpoint to report each group’s combined free rectangle. Ignored by the render itself (which takes the group from each label/logo’s slots).

Trait Implementations

impl Clone for GridRectangleRequest

fn clone(&self) -> GridRectangleRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GridRectangleRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GridRectangleRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.