Logo FSBarV1_Archived

ConfigDescriptors Module

Static attribute descriptor registry — the single source of truth for what's configurable in the Viz style configurator.

Functions and values

Function or value Description

all

Full Usage: all

Returns: AttributeDescriptor list

All configurable attributes, ordered by category then display order.

Returns: AttributeDescriptor list

applyValues values config

Full Usage: applyValues values config

Parameters:
Returns: VizConfig

Apply a map of key→value pairs to a VizConfig, returning updated config. Unknown keys are silently skipped.

values : Map<string, obj>
config : VizConfig
Returns: VizConfig

categoryLabel arg1

Full Usage: categoryLabel arg1

Parameters:
Returns: string

Display name for a category.

arg0 : AttributeCategory
Returns: string

categoryOrder

Full Usage: categoryOrder

Returns: AttributeCategory list

Category order for panel rendering.

Returns: AttributeCategory list

extractValues config

Full Usage: extractValues config

Parameters:
Returns: Map<string, obj>

Extract all current values from a VizConfig as a key→value map.

config : VizConfig
Returns: Map<string, obj>

isDirty current reference

Full Usage: isDirty current reference

Parameters:
Returns: bool

Check whether two configs differ on any descriptor.

current : VizConfig
reference : VizConfig
Returns: bool

tryFind key

Full Usage: tryFind key

Parameters:
    key : string

Returns: AttributeDescriptor option

Lookup a descriptor by key. Returns None if key is unknown.

key : string
Returns: AttributeDescriptor option

Type something to start searching.