Shape

class Shape : Scheme

Types

Companion

common

object Companion : SchemeSpec<Shape>

Functions

getItem

common

open override fun getItem(name: Name): MetaItem?

line

common

fun line(block: LayoutLine.() -> Unit)

onChange

common

open override fun onChange(owner: Any?, action: (Name, MetaItem?, MetaItem?) -> Unit)

removeListener

common

open override fun removeListener(owner: Any?)

setItem

common

open override fun setItem(name: Name, item: MetaItem?)

toMeta

common

open override fun toMeta(): Laminate

validateItem

common

open fun validateItem(name: Name, item: MetaItem?): Boolean

Properties

defaultLayer

common

open val defaultLayer: Meta

descriptor

common

override var descriptor: NodeDescriptor?

editable

common

var editable: Boolean?

Determines whether the shape could be activated for edit or not.

fillcolor

common

val fillcolor: Color

Sets the color filling the shape's interior.

fillrule

common

var fillrule: ShapeFillRule

Determines which regions of complex paths constitute the interior.

layer

common

var layer: ShapeLayer

Specifies whether shapes are drawn below or above traces.

line

common

var line: LayoutLine

name

common

var name: String?

When used in a template, named items are created in the output figure in addition to any items the figure already has in this array.

opacity

common

var opacity: Number

Sets the opacity of the shape.

path

common

var path: String?

For type "path" - a valid SVG path with the pixel values replaced by data values in xsizemode/ysizemode being "scaled" and taken unmodified as pixels relative to xanchor and yanchor in case of "pixel" size mode.

templateitemname

common

var templateitemname: String?

Used to refer to a named item in this array in the template.

type

common

var type: ShapeType

Specifies the shape type to be drawn.

visible

common

var visible: Boolean?

Determines whether or not this shape is visible.

common

var x0: Value?

Sets the shape's starting x position.

common

var x1: Value?

Sets the shape's end x position.

xanchor

common

var xanchor: Value?

Only relevant in conjunction with xsizemode set to "pixel".

xref

common

var xref: String?

Sets the shape's x coordinate axis.

xsizemode

common

var xsizemode: ShapeSizeMode

Sets the shapes's sizing mode along the x axis.

common

var y0: Value?

Sets the shape's starting y position.

common

var y1: Value?

Sets the shape's end y position.

yanchor

common

var yanchor: Value?

Only relevant in conjunction with ysizemode set to "pixel".

yref

common

var yref: String?

Sets the annotation's y coordinate axis.

ysizemode

common

var ysizemode: ShapeSizeMode

Sets the shapes's sizing mode along the y axis.