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

Jump to bottom

Add 'linetype' for theme elements #1072

Merged
merged 14 commits into from
Apr 3, 2024
Merged

Add 'linetype' for theme elements #1072

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
57bdaf1
Add interfaces to set stroke-dasharray attribute for svg elements.
OLarionova-HORIS Apr 2, 2024
55bc212
Add 'linetype' parsing as theme option.
OLarionova-HORIS Apr 2, 2024
cf3624e
For `plot_background`.
OLarionova-HORIS Apr 2, 2024
ac65c21
For `panel_background, panel_border, panel_grid_major/minor`.
OLarionova-HORIS Apr 2, 2024
79e10db
For `legend_background, strip_background`.
OLarionova-HORIS Apr 2, 2024
3898e7f
For `axis_line, axis_ticks`.
OLarionova-HORIS Apr 2, 2024
d791150
For `axis_line, axis_ticks`.
OLarionova-HORIS Apr 2, 2024
510397b
Add parameter 'linetype' to py functions.
OLarionova-HORIS Apr 2, 2024
50368f5
Renaming.
OLarionova-HORIS Apr 2, 2024
a63c36c
Cleanup code.
OLarionova-HORIS Apr 2, 2024
2da45ca
Fix docstrings.
OLarionova-HORIS Apr 2, 2024
da47377
Cleanup linetype parse function.
OLarionova-HORIS Apr 2, 2024
9339476
Add notebook.
OLarionova-HORIS Apr 3, 2024
2dbd3d1
Rename notebook. Update future_changes.md.
OLarionova-HORIS Apr 3, 2024
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
Next Next commit
Add interfaces to set stroke-dasharray attribute for svg elements.
  • Loading branch information
@OLarionova-HORIS
OLarionova-HORIS committed Apr 2, 2024
commit 57bdaf16d193cd9fbee6020ebcc726773c355ac5
5 changes: 5 additions & 0 deletions datamodel/src/commonMain/kotlin/org/jetbrains/letsPlot/datamodel/svg/dom/SvgCircleElement.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import org.jetbrains.letsPlot.commons.values.Color
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.FILL
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.FILL_OPACITY
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.STROKE
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.STROKE_DASHARRAY
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.STROKE_OPACITY
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.STROKE_WIDTH
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgTransformable.Companion.TRANSFORM
Expand Down Expand Up @@ -86,6 +87,10 @@ class SvgCircleElement() : SvgGraphicsElement(), SvgTransformable,
return getAttribute(STROKE_WIDTH)
}

override fun strokeDashArray(): Property<String?> {
return getAttribute(STROKE_DASHARRAY)
}

override fun pointToTransformedCoordinates(point: DoubleVector): DoubleVector {
return container().getPeer()!!.invertTransform(this, point)
}
Expand Down
5 changes: 5 additions & 0 deletions ...model/src/commonMain/kotlin/org/jetbrains/letsPlot/datamodel/svg/dom/SvgEllipseElement.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import org.jetbrains.letsPlot.commons.values.Color
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.FILL
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.FILL_OPACITY
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.STROKE
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.STROKE_DASHARRAY
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.STROKE_OPACITY
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.STROKE_WIDTH
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgTransformable.Companion.TRANSFORM
Expand Down Expand Up @@ -92,6 +93,10 @@ class SvgEllipseElement() : SvgGraphicsElement(),
return getAttribute(STROKE_WIDTH)
}

override fun strokeDashArray(): Property<String?> {
return getAttribute(STROKE_DASHARRAY)
}

override fun pointToTransformedCoordinates(point: DoubleVector): DoubleVector {
return container().getPeer()!!.invertTransform(this, point)
}
Expand Down
5 changes: 5 additions & 0 deletions datamodel/src/commonMain/kotlin/org/jetbrains/letsPlot/datamodel/svg/dom/SvgLineElement.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import org.jetbrains.letsPlot.commons.values.Color
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.FILL
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.FILL_OPACITY
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.STROKE
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.STROKE_DASHARRAY
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.STROKE_OPACITY
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.STROKE_WIDTH
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgTransformable.Companion.TRANSFORM
Expand Down Expand Up @@ -92,6 +93,10 @@ class SvgLineElement() : SvgGraphicsElement(), SvgTransformable,
return getAttribute(STROKE_WIDTH)
}

override fun strokeDashArray(): Property<String?> {
return getAttribute(STROKE_DASHARRAY)
}

override fun pointToTransformedCoordinates(point: DoubleVector): DoubleVector {
return container().getPeer()!!.invertTransform(this, point)
}
Expand Down
5 changes: 5 additions & 0 deletions datamodel/src/commonMain/kotlin/org/jetbrains/letsPlot/datamodel/svg/dom/SvgPathElement.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import org.jetbrains.letsPlot.commons.values.Color
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.FILL
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.FILL_OPACITY
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.STROKE
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.STROKE_DASHARRAY
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.STROKE_OPACITY
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.STROKE_WIDTH
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgTransformable.Companion.TRANSFORM
Expand Down Expand Up @@ -75,6 +76,10 @@ class SvgPathElement() : SvgGraphicsElement(), SvgTransformable,
return getAttribute(STROKE_WIDTH)
}

override fun strokeDashArray(): Property<String?> {
return getAttribute(STROKE_DASHARRAY)
}

fun strokeMiterLimit(): Property<Double?> {
return getAttribute(STROKE_MITER_LIMIT)
}
Expand Down
5 changes: 5 additions & 0 deletions datamodel/src/commonMain/kotlin/org/jetbrains/letsPlot/datamodel/svg/dom/SvgRectElement.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import org.jetbrains.letsPlot.commons.values.Color
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.FILL
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.FILL_OPACITY
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.STROKE
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.STROKE_DASHARRAY
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.STROKE_OPACITY
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape.Companion.STROKE_WIDTH
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgTransformable.Companion.TRANSFORM
Expand Down Expand Up @@ -96,6 +97,10 @@ class SvgRectElement() : SvgGraphicsElement(), SvgTransformable,
return getAttribute(STROKE_WIDTH)
}

override fun strokeDashArray(): Property<String?> {
return getAttribute(STROKE_DASHARRAY)
}

override fun pointToTransformedCoordinates(point: DoubleVector): DoubleVector {
return container().getPeer()!!.invertTransform(this, point)
}
Expand Down
4 changes: 4 additions & 0 deletions datamodel/src/commonMain/kotlin/org/jetbrains/letsPlot/datamodel/svg/dom/SvgShape.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ interface SvgShape {

fun strokeWidth(): Property<Double?>

fun strokeDashArray(): Property<String?>

companion object {
val FILL: SvgAttributeSpec<SvgColor> =
SvgAttributeSpec.createSpec("fill")
Expand All @@ -36,5 +38,7 @@ interface SvgShape {
SvgAttributeSpec.createSpec("stroke-opacity")
val STROKE_WIDTH: SvgAttributeSpec<Double> =
SvgAttributeSpec.createSpec("stroke-width")
val STROKE_DASHARRAY: SvgAttributeSpec<String> =
SvgAttributeSpec.createSpec(SvgConstants.SVG_STROKE_DASHARRAY_ATTRIBUTE)
}
}
25 changes: 4 additions & 21 deletions ...-base/src/commonMain/kotlin/org/jetbrains/letsPlot/core/plot/base/geom/util/GeomHelper.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,38 +317,21 @@ open class GeomHelper(

companion object {
fun decorate(
node: SvgNode,
shape: SvgShape,
p: DataPointAesthetics,
applyAlphaToAll: Boolean = ALPHA_CONTROLS_BOTH,
strokeScaler: (DataPointAesthetics) -> Double = AesScaling::strokeWidth,
filled: Boolean = true
) {
if (node is SvgShape) {
decorateShape(node as SvgShape, p, applyAlphaToAll, strokeScaler, filled)
}

if (node is SvgElement) {
val lineType = p.lineType()
if (!(lineType.isBlank || lineType.isSolid)) {
StrokeDashArraySupport.apply(node, strokeScaler(p), lineType.dashArray)
}
}
}

private fun decorateShape(
shape: SvgShape,
p: DataPointAesthetics,
applyAlphaToAll: Boolean,
strokeScaler: (DataPointAesthetics) -> Double,
filled: Boolean
) {
AestheticsUtil.updateStroke(shape, p, applyAlphaToAll)
if (filled) {
AestheticsUtil.updateFill(shape, p)
} else {
shape.fill().set(SvgColors.NONE)
}
shape.strokeWidth().set(strokeScaler(p))
val strokeWidth = strokeScaler(p)
shape.strokeWidth().set(strokeWidth)
StrokeDashArraySupport.apply(shape, strokeWidth, p.lineType())
}

internal fun decorateSlimShape(
Expand Down
4 changes: 1 addition & 3 deletions ...base/src/commonMain/kotlin/org/jetbrains/letsPlot/core/plot/base/geom/util/LinesHelper.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,9 +237,7 @@ open class LinesHelper(
path.width().set(size)

val lineType = p.lineType()
if (!(lineType.isBlank || lineType.isSolid)) {
path.dashArray().set(lineType.dashArray)
}
path.lineType().set(lineType)
}

private fun decorateFillingPart(path: LinePath, p: DataPointAesthetics) {
Expand Down
22 changes: 9 additions & 13 deletions plot-base/src/commonMain/kotlin/org/jetbrains/letsPlot/core/plot/base/render/svg/LinePath.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ package org.jetbrains.letsPlot.core.plot.base.render.svg
import org.jetbrains.letsPlot.commons.geometry.DoubleVector
import org.jetbrains.letsPlot.commons.intern.observable.property.WritableProperty
import org.jetbrains.letsPlot.commons.values.Color
import org.jetbrains.letsPlot.core.plot.base.render.linetype.LineType
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgColors
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgPathDataBuilder
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgPathElement
Expand All @@ -18,7 +19,7 @@ import org.jetbrains.letsPlot.datamodel.svg.dom.SvgPathElement
class LinePath(builder: SvgPathDataBuilder) : SvgComponent() {

private val myPath: SvgPathElement
private var myDashArray: List<Double>? = null
private var myLineType: LineType? = null

init {
myPath = SvgPathElement(builder.build())
Expand Down Expand Up @@ -81,24 +82,19 @@ class LinePath(builder: SvgPathDataBuilder) : SvgComponent() {
}
}

fun dashArray(): WritableProperty<List<Double>> {
return object : WritableProperty<List<Double>> {
override fun set(value: List<Double>) {
myDashArray = ArrayList(value)
fun lineType(): WritableProperty<LineType> {
return object : WritableProperty<LineType> {
override fun set(value: LineType) {
myLineType = value
updatePathDashArray()
}
}
}

private fun updatePathDashArray() {
if (!(myDashArray == null || myDashArray!!.isEmpty())) {
val w = myPath.strokeWidth().get()
val width = w ?: 1.0
StrokeDashArraySupport.apply(
myPath,
width,
myDashArray!!
)
if (myLineType != null) {
val width = myPath.strokeWidth().get() ?: 1.0
StrokeDashArraySupport.apply(myPath, width, myLineType!!)
}
}

Expand Down
22 changes: 16 additions & 6 deletions ...monMain/kotlin/org/jetbrains/letsPlot/core/plot/base/render/svg/StrokeDashArraySupport.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,34 @@

package org.jetbrains.letsPlot.core.plot.base.render.svg

import org.jetbrains.letsPlot.datamodel.svg.dom.SvgConstants
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgElement
import org.jetbrains.letsPlot.core.plot.base.render.linetype.LineType
import org.jetbrains.letsPlot.datamodel.svg.dom.SvgShape

/**
* The counterpart of SVG 'stroke-dasharray' attribute but
* length of alternating dashes and gaps
* is defined as multiples of line width
*/
object StrokeDashArraySupport {
fun apply(element: SvgElement, strokeWidth: Double, dashArray: List<Double>) {
fun apply(element: SvgShape, strokeWidth: Double, lineType: LineType) {
val dashArray = toStrokeDashArray(strokeWidth, lineType)
if (dashArray != null) {
element.strokeDashArray().set(dashArray)
}
}

private fun toStrokeDashArray(strokeWidth: Double, lineType: LineType): String? {
if (lineType.isBlank || lineType.isSolid) {
return null
}
val sb = StringBuilder()
for (relativeLength in dashArray) {
lineType.dashArray.forEach { relativeLength ->
val length = relativeLength * strokeWidth
if (sb.length > 0) {
if (sb.isNotEmpty()) {
sb.append(',')
}
sb.append(length.toString())
}
element.getAttribute(SvgConstants.SVG_STROKE_DASHARRAY_ATTRIBUTE).set(sb.toString())
return sb.toString()
}
}