ColorLegendCollection

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

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

Methods Documentation

create_color_legend(name: str = '') → ColorLegend

Create a new custom color legend

custom_color_legends() → List[ColorLegend]

Custom Color Legends

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

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

Parameters:

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:

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:

Returns: