ColorLegendCollection

class rips.ColorLegendCollection(pb2_object: PdmObject | None = None, channel: Channel | None = None)

Bases: PdmObjectBase

Methods Summary

create_color_legend([name])	Create a new custom color legend
custom_color_legends()	Custom Color Legends
delete_color_legend([case, result_name])	Remove the color legend bound to a (case, resultName) pair
find_default_legend_for_result([case, ...])	Look up the color legend bound to a (case, resultName) pair
set_default_color_legend_for_result([case, ...])	Bind a color legend to a (case, resultName) pair
update_color_legend([case, result_name, ...])	Update the color legend bound to a (case, resultName) pair in place, creating it if needed

Methods Documentation

create_color_legend(name: str = '') → ColorLegend

Create a new custom color legend

Parameters:

name (str)

Returns:

ColorLegend

custom_color_legends() → List[ColorLegend]

Custom Color Legends

Returns:

List[ColorLegend]

delete_color_legend(case: Case | None = None, result_name: str = '') → None

Remove the color legend bound to a (case, resultName) pair

Parameters:

• case (Optional[Case])

• result_name (str)

Returns:

find_default_legend_for_result(case: Case | None = None, result_name: str = '') → ColorLegend | None

Look up the color legend bound to a (case, resultName) pair

Parameters:

• case (Optional[Case])

• result_name (str)

Returns:

ColorLegend

set_default_color_legend_for_result(case: Case | None = None, result_name: str = '', color_legend: ColorLegend | None = None) → None

Bind a color legend to a (case, resultName) pair

Parameters:

• case (Optional[Case])

• result_name (str)

• color_legend (Optional[ColorLegend])

Returns:

update_color_legend(case: Case | None = None, result_name: str = '', legend_name: str = '', category_values: List[int] = [], category_names: List[str] = [], colors: List[str] = []) → ColorLegend

Update the color legend bound to a (case, resultName) pair in place, creating it if needed

Parameters:

• case (Optional[Case])

• result_name (str)

• legend_name (str)

• category_values (List[int])

• category_names (List[str])

• colors (List[str])

Returns:

ColorLegend