Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add kdoc about "Open in browser" from IDEA that helps to streamline working with HTML rendering #968

Merged
merged 1 commit into from
Dec 12, 2024
Merged

Add kdoc about "Open in browser" from IDEA that helps to streamline working with HTML rendering #968

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions core/api/core.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10347,6 +10347,7 @@ public final class org/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData {
public fun toString ()Ljava/lang/String;
public final fun withTableDefinitions ()Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
public final fun writeHTML (Ljava/io/File;)V
public final fun writeHTML (Ljava/lang/String;)V
public final fun writeHTML (Ljava/nio/file/Path;)V
}

Expand Down
14 changes: 13 additions & 1 deletion core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/html.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -518,7 +518,11 @@ internal fun DataFrameHtmlData.print() = println(this)
/**
* By default, cell content is formatted as text
* Use [RenderedContent.media] or [IMG], [IFRAME] if you need custom HTML inside a cell.
* @return DataFrameHtmlData with table script and css definitions. Can be saved as an *.html file and displayed in the browser
*
* The [DataFrameHtmlData] be saved as an *.html file and displayed in the browser.
* If you save it as a file and find it in the project tree,
* the ["Open in browser"](https://www.jetbrains.com/help/idea/editing-html-files.html#ws_html_preview_output_procedure) feature of IntelliJ IDEA will automatically reload the file content when it's updated
* @return DataFrameHtmlData with table script and css definitions
*/
public fun <T> DataFrame<T>.toStandaloneHTML(
configuration: DisplayConfiguration = DisplayConfiguration.DEFAULT,
Expand Down Expand Up @@ -620,10 +624,18 @@ public data class DataFrameHtmlData(
destination.writeText(toString())
}

public fun writeHTML(destination: String) {
File(destination).writeText(toString())
}

public fun writeHTML(destination: Path) {
destination.writeText(toString())
}

/**
* Opens a new tab in your default browser.
* Consider [writeHTML] with the [HTML file auto-reload](https://www.jetbrains.com/help/idea/editing-html-files.html#ws_html_preview_output_procedure) feature of IntelliJ IDEA if you want to experiment with the output and run program multiple times
*/
public fun openInBrowser() {
val file = File.createTempFile("df_rendering", ".html")
writeHTML(file)
Expand Down
Loading