Package 

Interface DisplayResult

  • All Implemented Interfaces:
    org.jetbrains.kotlinx.jupyter.api.Renderable 
    
public interface DisplayResult
 implements Renderable

    Display result that may be converted to JSON for display_data kernel response

    • Method Summary

      Modifier and Type Method Description
      abstract JsonObject toJson(JsonObject additionalMetadata) Converts display data to JSON object for display_data response
      DisplayResult render(Notebook notebook) Renders display result, generally should return this
      String getId()

      • Methods inherited from class org.jetbrains.kotlinx.jupyter.api.Renderable

        equals, hashCode, toString

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • toJson

         abstract JsonObject toJson(JsonObject additionalMetadata)

        Converts display data to JSON object for display_data response

        Parameters:
        additionalMetadata - Additional reply metadata

      • render

         DisplayResult render(Notebook notebook)

        Renders display result, generally should return this

        Parameters:
        notebook - Current notebook