Struct ViewParams 

pub struct ViewParams {

    pub view_id: String,
    pub width: u32,
    pub height: u32,
    pub aspect_ratio_mode: AspectRatioMode,
    pub aspect_ratio_alignment_mode: AspectRatioAlignmentMode,
    pub device_pixel_ratio: f32,
    pub camera_view: Option<[f32; 16]>,
    pub timeout: Option<u32>,
    pub wait_for_store_gets: bool,
    pub cache_enabled: bool,
    pub margins: Option<MarginParams>,
    pub stores: Option<HashMap<String, ZarrStoreInfo>>,
    pub store_objects: Option<StoreMap>,
}

Shared rendering parameters at the view level (i.e., not layer-specific).

Fields

view_id: String

The view ID.

width: u32

height: u32

aspect_ratio_mode: AspectRatioMode

aspect_ratio_alignment_mode: AspectRatioAlignmentMode

device_pixel_ratio: f32

camera_view: Option<[f32; 16]>

The camera state, as a 4x4 matrix.

timeout: Option<u32>

Timeout (in ms) before bailing out of awaiting a data request.

wait_for_store_gets: bool

If false, bail early (e.g., upon encountering a pending Promise) rather than waiting for data requests to resolve.

cache_enabled: bool

Allow disabling memoization/cacheing.

margins: Option<MarginParams>

Specify margins for plots that need them (e.g. scatterplot axes).

Subtract margins from view-level width/height to obtain layer-level width/height.

stores: Option<HashMap<String, ZarrStoreInfo>>

Mapping from zarr store name to its metadata.

Keeping track of store metadata in parallel with the store instances in [store_objects] enables serializing store info, facilitating the render-to-script functionality.

store_objects: Option<StoreMap>

Mapping from zarr store name to its zarrs store instance.

Not serialized.

Implementations

impl ViewParams

pub fn get_store(&self, store_name: &str) -> Arc<dyn AsyncReadableStorageTraits>

Given a Zarr store name, obtain the corresponding store instance from the ViewParams::store_objects hashmap.

Trait Implementations

impl Clone for ViewParams

fn clone(&self) -> ViewParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ViewParams

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

Formats the value using the given formatter.

impl Default for ViewParams

fn default() -> ViewParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ViewParams

fn deserialize<__D>( __deserializer: __D, ) -> Result<ViewParams, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ViewParams

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.