Types Used in the Grammar¶
Note
The list is still incomplete.
CompareParams¶
field
Required-
Type: string (field name)[] | string (field name)
The field(s) to sort by
order
-
Type: (
"ascending"
|"descending"
)[] |"ascending"
|"descending"
The order(s) to use:
"ascending"
(default),"descending"
.
DynamicOpacity¶
channel
-
Type:
"x"
|"y"
TODO
unitsPerPixel
Required-
Type: array
Stops expressed as units (base pairs, for example) per pixel.
values
Required-
Type: array
Opacity values that match the given stops.
ExprRef¶
expr
Required-
Type: string
The expression string.
Paddings¶
bottom
-
Type: number
TODO
left
-
Type: number
TODO
right
-
Type: number
TODO
top
-
Type: number
TODO
Step¶
step
Required-
Type: number
TODO
SizeDef¶
grow
-
Type: number
Share of the remaining space. See child sizing for details.
px
-
Type: number
Size in pixels
Title¶
align
-
Type:
"left"
|"center"
|"right"
Horizontal text alignment for title text. One of
"left"
,"center"
, or"right"
. anchor
-
Type:
None
|start
|middle
|end
The anchor position for placing the title and subtitle text. One of
"start"
,"middle"
, or"end"
. For example, with an orientation of top these anchor positions map to a left-, center-, or right-aligned title. angle
-
Type: number | ExprRef
Angle in degrees of title and subtitle text.
baseline
-
Type:
"top"
|"middle"
|"bottom"
|"alphabetic"
Vertical text baseline for title and subtitle text. One of
"alphabetic"
(default),"top"
,"middle"
, or"bottom"
. color
-
Type: string | ExprRef
Text color for title text.
dx
-
Type: number
Delta offset for title and subtitle text x-coordinate.
dy
-
Type: number
Delta offset for title and subtitle text y-coordinate.
font
-
Type: string
Font name for title text.
fontSize
-
Type: number | ExprRef
Font size in pixels for title text.
fontStyle
-
Type:
"normal"
|"italic"
Font style for title text.
fontWeight
-
Type: number |
"thin"
|"light"
|"regular"
|"normal"
|"medium"
|"bold"
|"black"
Font weight for title text. This can be either a string (e.g
"bold"
,"normal"
) or a number (100
,200
,300
, ...,900
where"normal"
=400
and"bold"
=700
). frame
-
Type:
"bounds"
|"group"
The reference frame for the anchor position, one of
"bounds"
(to anchor relative to the full bounding box) or"group"
(to anchor relative to the group width or height). offset
-
Type: number
The orthogonal offset in pixels by which to displace the title group from its position along the edge of the chart.
orient
-
Type:
"none"
|"left"
|"right"
|"top"
|"bottom"
Default title orientation (
"none"
,"top"
,"bottom"
,"left"
, or"right"
) style
-
Type: string
A mark style property to apply to the title text mark. If not specified, a default style of
"group-title"
is applied. text
Required-
Type: string | ExprRef
The title text.
ViewBackground¶
fill
-
Type: string | ExprRef
The fill color.
fillOpacity
-
Type: number | ExprRef
The fill opacity. Value between
0
and1
. stroke
-
Type: string | ExprRef
The stroke color
strokeOpacity
-
Type: number | ExprRef
The stroke opacity. Value between
0
and1
. strokeWidth
-
Type: number
The stroke width in pixels.
ViewOpacityDef¶
Type: number | DynamicOpacity | ExprRef