graph » scale-x » guide

guide

[ root » graph » scale-x » guide ]

Use the guide object to customize the scale guides for scaleX. Refer to the X/Y-Axis Scales Tutorial for more information.


AttributeTypeInfo
alphaNumeric

Sets the transparency of the scale-x / scale-y guide. See the red lines.

0.3 | 0.9 | ...

background-color
backgroundColor
String

Sets the background color of the scale-x / scale-y guide. See the blue background in between the red lines.

"none" | "transparent" | "#f00" | "#f00 #00f" | "red yellow" | "rgb(100, 15, 15)" | ...

background-color-1
backgroundColor1
String

Sets the first color of a 2 color background gradient of the object. To be used with background-color-2.

"none" | "transparent" | "#f00" | "#f00 #00f" | "red yellow" | "rgb(100, 15, 15)" | ...

background-color-2
backgroundColor2
String

Sets the second color of a 2 color background gradient of the object. To be used with background-color-1.

"none" | "transparent" | "#f00" | "#f00 #00f" | "red yellow" | "rgb(100, 15, 15)" | ...

itemsArray

An array of objects, with each object containing styling attributes. Each object in the "items" array sets the styling attributes for the area at each index across the scale. A single object in "items" will have its attributes applied along every index. Two objects will have their attributes applied in an alternating manner across the indices of a scale. Three objects or more will have their attributes applied across the indices in a rotating manner.

[...]

line-color
lineColor
String

Sets the line color of the scale-x / scale-y guide. See the red lines.

"none" | "transparent" | "#f00" | "#f00 #00f" | "red yellow" | "rgb(100, 15, 15)" | ...

line-gap-size
lineGapSize
Mixed

When using a dashed or dotted line-type, this will set the size of each gap between line segments. Can be used with line-segment-size to create unique dashed or dotted lines. For the scale-x / scale-y guide. See the space between red lines.

4 | "6px" | ...

line-segment-size
lineSegmentSize
Mixed

When using a dashed or dotted line-type, this will set the size of each visible segment of line. Can be used with line-gap-size to create unique dashed or dotted lines. For the scale-x / scale-y guide. See the red lines.

4 | "6px" | ...

line-style
lineStyle
String

Sets the style applied to lines and borders of the scale-x / scale-y guide. See the red lines.

"solid" | "dotted" | "dashed" | "dashdot"

line-width
lineWidth
Mixed

Sets the line width of the object, applicable on non-closed shapes. For the scale-x / scale-y guide. See the red lines.

4 | "6px" | ...

visibleBoolean

Sets the visibility of the object. Allows you to turn off the object without removing lines of JSON.

true | false | 1 | 0