kappa_sdk.Plot#

class kappa_sdk.Plot(field_id, well_id, plot_id, plot_name, field_api, data_types_catalog, dto_converter)[source]#

Plot object.

Presents a KAPPA Automate Plot object.

Attributes

Plot.id

Gets the id of the Plot object.

Plot.name

Gets the name of the Plot object.

Methods

Plot.add_cross_plot_data(x_data, y_data[, ...])

Adds cross plot data to the visualization, enabling plotting of X versus Y data points with customizable display options and metadata.

Plot.add_embedded_data(data[, channel_name, ...])

Add data to the Plot object.

Plot.add_existing_data(data[, channel_name, ...])

Add data to the Plot object.

Plot.add_sub_plot(name[, square_log_cycles, ...])

Add a new subplot or pane to the Plot object

Plot.delete()

Delete the current plot

Plot.get_plot_dto()

Get the plot dto from Kappa Automate

Plot.rename(name)

Rename the Plot object.

Plot.update_plot()

Update the plot in Kappa Automate

Parameters:
  • field_id (str)

  • well_id (str)

  • plot_id (str)

  • plot_name (str)

  • field_api (FieldAPI)

  • data_types_catalog (FieldDataTypesCatalog)

  • dto_converter (PlotDtoConverter)