Skip to content

Commit f8201e2

Browse files
JolanrensenJolanrensen
committed
format updates based on feedback
1 parent d39baa1 commit f8201e2

File tree

7 files changed

+53
-13
lines changed

7 files changed

+53
-13
lines changed

‎core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/format.kt

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ import org.jetbrains.kotlinx.dataframe.io.toHtml
4040
import org.jetbrains.kotlinx.dataframe.io.toStandaloneHtml
4141
import org.jetbrains.kotlinx.dataframe.jupyter.RenderedContent.Companion.media
4242
import org.jetbrains.kotlinx.dataframe.util.DEPRECATED_ACCESS_API
43+
import org.jetbrains.kotlinx.dataframe.util.FORMATTING_DSL
44+
import org.jetbrains.kotlinx.dataframe.util.FORMATTING_DSL_REPLACE
45+
import org.jetbrains.kotlinx.dataframe.util.RGB_COLOR
46+
import org.jetbrains.kotlinx.dataframe.util.RGB_COLOR_REPLACE
4347
import kotlin.reflect.KProperty
4448

4549
// region docs
@@ -833,3 +837,21 @@ public class FormatClause<T, C>(
833837
}
834838

835839
// endregion
840+
841+
// region Deprecated
842+
843+
@Deprecated(
844+
message = FORMATTING_DSL,
845+
replaceWith = ReplaceWith(FORMATTING_DSL_REPLACE),
846+
level = DeprecationLevel.ERROR,
847+
)
848+
public typealias FormattingDSL = FormattingDsl
849+
850+
@Deprecated(
851+
message = RGB_COLOR,
852+
replaceWith = ReplaceWith(RGB_COLOR_REPLACE),
853+
level = DeprecationLevel.ERROR,
854+
)
855+
public typealias RGBColor = RgbColor
856+
857+
// endregion

‎core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/util/deprecationMessages.kt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,12 @@ internal const val TO_URL_REPLACE = "toUrl()"
113113
internal const val FILTER_BY = "This function is deprecated in favor of `filter { }`. $MESSAGE_1_0"
114114
internal const val FILTER_BY_REPLACE = "filter { column }"
115115

116+
internal const val FORMATTING_DSL = "Replaced by `FormattingDsl`. $MESSAGE_1_0"
117+
internal const val FORMATTING_DSL_REPLACE = "FormattingDsl"
118+
119+
internal const val RGB_COLOR = "Replaced by `RgbColor`. $MESSAGE_1_0"
120+
internal const val RGB_COLOR_REPLACE = "RgbColor"
121+
116122
// endregion
117123

118124
// region WARNING in 1.0, ERROR in 1.1

‎docs/StardustDocs/resources/modify/operations/formatExampleNumbers.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@
177177
</style>
178178
</head>
179179
<body>
180-
<table class="dataframe" id="df_-1761607680"></table>
180+
<table class="dataframe" id="df_-788529151"></table>
181181

182182
<p class="dataframe_description"></p>
183183
</body>
@@ -467,10 +467,10 @@
467467
{ name: "<span title=\"col8: Int\">col8</span>", children: [], rightAlign: true, values: [{ style: "background-color:#ffffff;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">89</span></span>"},{ style: "background-color:#a9a9a9;color:#ffffff;--text-color:#ffffff !important;--text-color-dark:#ffffff !important;--text-color-pale:#ffffff !important;--text-color-medium:#ffffff !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">23</span></span>"},{ style: "background-color:#ffffff;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">56</span></span>"},{ style: "background-color:#ffffff;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">12</span></span>"},{ style: "background-color:#a9a9a9;color:#ffffff;--text-color:#ffffff !important;--text-color-dark:#ffffff !important;--text-color-pale:#ffffff !important;--text-color-medium:#ffffff !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">67</span></span>"},{ style: "background-color:#ffffff;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">90</span></span>"},{ style: "background-color:#ffffff;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">78</span></span>"},{ style: "background-color:#a9a9a9;color:#ffffff;--text-color:#ffffff !important;--text-color-dark:#ffffff !important;--text-color-pale:#ffffff !important;--text-color-medium:#ffffff !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">34</span></span>"},{ style: "background-color:#ffffff;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">45</span></span>"},{ style: "background-color:#ffffff;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">89</span></span>"}] },
468468
{ name: "<span title=\"col9: Int\">col9</span>", children: [], rightAlign: true, values: [{ style: "background-color:#ffffff;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">56</span></span>"},{ style: "background-color:#ffffff;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">67</span></span>"},{ style: "background-color:#a9a9a9;color:#ffffff;--text-color:#ffffff !important;--text-color-dark:#ffffff !important;--text-color-pale:#ffffff !important;--text-color-medium:#ffffff !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">34</span></span>"},{ style: "background-color:#ffffff;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">56</span></span>"},{ style: "background-color:#ffffff;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">23</span></span>"},{ style: "background-color:#a9a9a9;color:#ffffff;--text-color:#ffffff !important;--text-color-dark:#ffffff !important;--text-color-pale:#ffffff !important;--text-color-medium:#ffffff !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">45</span></span>"},{ style: "background-color:#ffffff;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">89</span></span>"},{ style: "background-color:#ffffff;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">78</span></span>"},{ style: "background-color:#a9a9a9;color:#ffffff;--text-color:#ffffff !important;--text-color-dark:#ffffff !important;--text-color-pale:#ffffff !important;--text-color-medium:#ffffff !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">12</span></span>"},{ style: "background-color:#ffffff;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">34</span></span>"}] },
469469
{ name: "<span title=\"col10: Int\">col10</span>", children: [], rightAlign: true, values: [{ style: "background-color:#a9a9a9;color:#ffffff;--text-color:#ffffff !important;--text-color-dark:#ffffff !important;--text-color-pale:#ffffff !important;--text-color-medium:#ffffff !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">43</span></span>"},{ style: "background-color:#ffffff;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">89</span></span>"},{ style: "background-color:#ffffff;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">78</span></span>"},{ style: "background-color:#a9a9a9;color:#ffffff;--text-color:#ffffff !important;--text-color-dark:#ffffff !important;--text-color-pale:#ffffff !important;--text-color-medium:#ffffff !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">23</span></span>"},{ style: "background-color:#ffffff;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">90</span></span>"},{ style: "background-color:#ffffff;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">12</span></span>"},{ style: "background-color:#a9a9a9;color:#ffffff;--text-color:#ffffff !important;--text-color-dark:#ffffff !important;--text-color-pale:#ffffff !important;--text-color-medium:#ffffff !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">67</span></span>"},{ style: "background-color:#ffffff;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">90</span></span>"},{ style: "background-color:#ffffff;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">34</span></span>"},{ style: "background-color:#a9a9a9;color:#ffffff;--text-color:#ffffff !important;--text-color-dark:#ffffff !important;--text-color-pale:#ffffff !important;--text-color-medium:#ffffff !important", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">78</span></span>"}] },
470-
], id: -1761607680, rootId: -1761607680, totalRows: 10 } ) });
470+
], id: -788529151, rootId: -788529151, totalRows: 10 } ) });
471471
/*-->*/
472472

473-
call_DataFrame(function() { DataFrame.renderTable(-1761607680) });
473+
call_DataFrame(function() { DataFrame.renderTable(-788529151) });
474474

475475
function sendHeight() {
476476
const table = document.querySelector('table.dataframe');

‎docs/StardustDocs/resources/modify/operations/formatExample_properties.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@
177177
</style>
178178
</head>
179179
<body>
180-
<table class="dataframe" id="df_1979711488"></table>
180+
<table class="dataframe" id="df_-788529152"></table>
181181

182182
<p class="dataframe_description"></p>
183183
</body>
@@ -464,10 +464,10 @@
464464
{ name: "<span title=\"city: String?\">city</span>", children: [], rightAlign: false, values: [{ style: "font-weight:bold;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important;background-color:#ffffff", value: "London"},{ style: "font-weight:bold;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important;background-color:#ffffff", value: "Dubai"},{ style: "font-weight:bold;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important;background-color:#ffffff", value: "Moscow"},{ style: "font-weight:bold;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important;background-color:#ffffff", value: "Milan"},{ style: "font-weight:bold;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important;background-color:#ffffff", value: "Tokyo"},{ style: "font-weight:bold;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important;background-color:#ffffff", value: "<span class=\"formatted\" title=\"\"><span class=\"null\">null</span></span>"},{ style: "font-weight:bold;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important;background-color:#ffffff", value: "Moscow"}] },
465465
{ name: "<span title=\"weight: Int?\">weight</span>", children: [], rightAlign: true, values: [{ style: "font-weight:bold;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important;background-color:#1900e5", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">54</span></span>"},{ style: "font-weight:bold;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important;background-color:#eb0013", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">87</span></span>"},{ style: "font-weight:bold;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important;background-color:#ffffff", value: "<span class=\"formatted\" title=\"\"><span class=\"null\">null</span></span>"},{ style: "font-weight:bold;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important;background-color:#ffffff", value: "<span class=\"formatted\" title=\"\"><span class=\"null\">null</span></span>"},{ style: "font-weight:bold;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important;background-color:#72008c", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">68</span></span>"},{ style: "font-weight:bold;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important;background-color:#1f00df", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">55</span></span>"},{ style: "font-weight:bold;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important;background-color:#ff0000", value: "<span class=\"formatted\" title=\"\"><span class=\"numbers\">90</span></span>"}] },
466466
{ name: "<span title=\"isHappy: Boolean\">isHappy</span>", children: [], rightAlign: false, values: [{ style: "font-weight:bold;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important;background-color:#00ff00", value: "true"},{ style: "font-weight:bold;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important;background-color:#00ff00", value: "true"},{ style: "font-weight:bold;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important;background-color:#ff0000", value: "false"},{ style: "font-weight:bold;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important;background-color:#00ff00", value: "true"},{ style: "font-weight:bold;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important;background-color:#00ff00", value: "true"},{ style: "font-weight:bold;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important;background-color:#ff0000", value: "false"},{ style: "font-weight:bold;color:#000000;--text-color:#000000 !important;--text-color-dark:#000000 !important;--text-color-pale:#000000 !important;--text-color-medium:#000000 !important;background-color:#00ff00", value: "true"}] },
467-
], id: 1979711488, rootId: 1979711488, totalRows: 7 } ) });
467+
], id: -788529152, rootId: -788529152, totalRows: 7 } ) });
468468
/*-->*/
469469

470-
call_DataFrame(function() { DataFrame.renderTable(1979711488) });
470+
call_DataFrame(function() { DataFrame.renderTable(-788529152) });
471471

472472
function sendHeight() {
473473
const table = document.querySelector('table.dataframe');

0 commit comments

Comments
 (0)