kappa_sdk.PlotChannel#

class kappa_sdk.PlotChannel(data_types_catalog, pane_name=None)[source]#

Build a PlotChannel dto for the Plot object.

Note

Should not be instantiated directly.

Attributes

PlotChannel.dto

class: PlotChannel

PlotChannel.pane_name

class: PlotChannel

Methods

PlotChannel.build_cross_plot_channel(...[, ...])

Builds a cross-plot channel with the specified x and y vectors, data type, and properties.

PlotChannel.build_embedded(data[, ...])

Build plot channel from embedded data

PlotChannel.build_time_series(data[, properties])

Build plot channel from a time series

PlotChannel.set_band_aspect([color, opacity])

Set up the band's aspect of the ChannelsModel

PlotChannel.set_channel_aspect([...])

Set up some aspect of the ChannelsModel :param drawing_style: :param is_y_log: :param hide_in_legend: :param is_raw:

PlotChannel.set_lines_aspect([color, width, ...])

Set up the line's aspect of the ChannelsModel

PlotChannel.set_symbols_aspect([color, ...])

Set up the symbols' aspect of the ChannelsModel
Parameters:
__init__(data_types_catalog, pane_name=None)[source]#
Parameters:
build_time_series(data, properties=None)[source]#

Build plot channel from a time series

Parameters:

  • well_id – Id of the well

  • data (Data) – Data object to be plotted

  • properties (PlotProperties | None) – Properties of the channel

Return type:

None

build_embedded(data, data_type=None, properties=None)[source]#

Build plot channel from embedded data

Parameters:

  • data (Vector | Tuple[List[float], List[float]]) – Data to build the channel could be either a Vector or a Tuple of lists

  • data_type (PlotDataTypesEnum | str | None) – Data type of the data

  • properties (PlotProperties | None) – Properties of the channel

Return type:

None

build_cross_plot_channel(x_vector_id, y_vector_id, data_type=None, properties=None)[source]#

Builds a cross-plot channel with the specified x and y vectors, data type, and properties.

This function initializes a cross-plot channel DTO (Data Transfer Object) based on the input parameters. The plot’s properties, such as channel name, logarithmic scaling, and visibility in the legend, are determined by the properties object. If no properties are specified, default ones are generated. The function assigns the constructed DTO to the internal state.

Parameters:

  • x_vector_id (str) – Identifier for the x-axis vector in the cross-plot channel.

  • y_vector_id (str) – Identifier for the y-axis vector in the cross-plot channel.

  • data_type (Optional[Union[PlotDataTypesEnum, str]], optional) – Specifies the data type for the plot. Can be either an enumeration value from PlotDataTypesEnum or a string representation. Default is None.

  • properties (Optional[PlotProperties], optional) – Contains specific descriptive elements for the plot, such as channel name, logarithmic options, and legend visibility. Default is None.

Return type:

None

set_lines_aspect(color=None, width=None, style=None)[source]#

Set up the line’s aspect of the ChannelsModel

Parameters:

  • color (str | None) – Line color

  • width (int | None) – Line width

  • style (LineAspectEnum | None) – Line style

Return type:

None

set_band_aspect(color=None, opacity=None)[source]#

Set up the band’s aspect of the ChannelsModel

Parameters:

  • color (str | None) – Band color

  • opacity (int | None) – Band opacity between 0 and 100

Return type:

None

set_symbols_aspect(color=None, size=None, filled=None, symbol_type=None)[source]#

Set up the symbols’ aspect of the ChannelsModel

Parameters:

  • color (str | None) – Symbols’ color

  • size (int | None) – Symbols’ size

  • filled (bool | None) – Symbols’ filled

  • symbol_type (SymbolAspectEnum | None) – Symbol’s type

Return type:

None

set_channel_aspect(drawing_style=None, is_y_log=None, hide_in_legend=None, is_raw=None)[source]#

Set up some aspect of the ChannelsModel :param drawing_style: :param is_y_log: :param hide_in_legend: :param is_raw:

Parameters:

  • drawing_style (DrawingStyle | None)

  • is_y_log (bool | None)

  • hide_in_legend (bool | None)

  • is_raw (bool | None)

Return type:

None

property pane_name: str | None#

class: PlotChannel

Type:

Get associated pane name of the

property dto: EmbeddedChannelDto | TimeSeriesReferenceChannelDto | CrossReferenceChannelDto | None#

class: PlotChannel

Type:

Get associated dto of the