kappa_sdk.PlotChannel#

class kappa_sdk.PlotChannel(field_id, 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(...[, ...])

Build plot channel from embedded data

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

Build plot channel from embedded data

PlotChannel.build_time_series(well_id, data)

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__(field_id, data_types_catalog, pane_name=None)[source]#
Parameters:
build_time_series(well_id, data, properties=None)[source]#

Build plot channel from a time series

Parameters:

  • well_id (str) – Id of the well

  • data (Data) – Data object to be plotted

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

Return type:

None

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

Build plot channel from embedded data

Parameters:

  • well_id (str) – Id of the well

  • 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(well_id, x_vector_id, y_vector_id, data_type=None, properties=None)[source]#

Build plot channel from embedded data

Parameters:

  • well_id (str) – Id of the well

  • data – 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

  • x_vector_id (str)

  • y_vector_id (str)

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