ChevronLineConfig
interface ChevronLineConfig<A extends Annotation, C extends Chart>
An interface that defines the parameters for a call to the chevronLine rendering function.
Type parameters
A: Annotation
C: Chart
Properties
annotations
annotations: A []
A list of Annotation objects that will be used to render the glyphs.
chart
chart: C
The Chart object in which the glyphs will be rendered.
chevronFillColor
chevronFillColor: undefined | string | GlyphCallback <A, C, string>
This defines the fill color of the chevron arrows.
chevronFillOpacity
chevronFillOpacity: undefined | number | GlyphCallback <A, C, number>
This defines the fill opacity of the chevron arrows.
chevronHeight
chevronHeight: undefined | number | GlyphCallback <A, C, number>
This defines the height of the chevron arrows.
chevronSpacing
chevronSpacing: undefined | number | GlyphCallback <A, C, number>
This defines the spacing between each chevron arrow.
chevronStrokeColor
chevronStrokeColor: undefined | string | GlyphCallback <A, C, string>
This defines the stroke color of the chevron arrows.
chevronStrokeOpacity
chevronStrokeOpacity: undefined | number | GlyphCallback <A, C, number>
This defines the stroke opacity of the chevron arrows.
chevronWidth
chevronWidth: undefined | number | GlyphCallback <A, C, number>
This defines the width of the chevron arrows.
fillColor
fillColor: undefined | string | GlyphCallback <A, C, string>
A callback to define the fill color of the glyph.
fillOpacity
fillOpacity: undefined | number | GlyphCallback <A, C, number>
A callback to define the fill opacity of the glyph.
height
height: undefined | number | GlyphCallback <A, C, number>
A callback to define the pixel height of the glyph.
initializeFn
initializeFn: undefined | (): void
A callback function that will be passed to the GlyphModifier that will manage the glyphs created with this config. If provided, this callback function will override the GlyphModifier’s initialization method, which typically sets most of the style related properties from the GlyphConfig. Don’t use this unless you know what you’re doing.
orientation
orientation: undefined | Forward | Reverse | Unknown | Unoriented | GlyphCallback <A, C, Orientation>
This defines the direction that the chevron arrows will point.
row
row: undefined | number | GlyphCallback <A, C, number>
A callback to define the row that the glyph is placed in.
selector
selector: undefined | string
The string that will be used to uniquely identify the call to the glyph rendering function. In the DOM, the glyphs’ elements will have this assigned as an ID. If the same selector is supplied to two distinct calls to the same glyph function, the rendering results of the first call will be cleared and replaced with the results of the second.
strokeColor
strokeColor: undefined | string | GlyphCallback <A, C, string>
A callback to define the color of the border around the glyph.
strokeDashArray
strokeDashArray: undefined | string | GlyphCallback <A, C, string>
A callback to define the stroke dash array of the glyph. See https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray
strokeDashOffset
strokeDashOffset: undefined | string | GlyphCallback <A, C, string>
A callback to define the offset for the stroke dash array (if supplied) of the glyph. See https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dashoffset
strokeLineCap
strokeLineCap: undefined | string | GlyphCallback <A, C, string>
A callback to define the stroke linecap of the glyph. See https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap
strokeLineJoin
strokeLineJoin: undefined | string | GlyphCallback <A, C, string>
A callback to define the offset for the stroke linejoin of the glyph. See https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linejoin
strokeOpacity
strokeOpacity: undefined | number | GlyphCallback <A, C, number>
A callback to define the opacity of the border around the glyph.
strokeWidth
strokeWidth: undefined | number | GlyphCallback <A, C, number>
A callback to define the width of the border around the glyph.
target
target: undefined | Selection <any, any, any, any> | Viewport | Overflow | Defs
This determines the parent DOM element in which the glyphs will be rendered. When supplying a BindTarget, the rendering function will find the appropriate parent in the supplied Chart. When supplying a D3 selection, the rendering function will explicitly use the selected element.
width
width: undefined | number | GlyphCallback <A, C, number>
A callback to define the pixel width of the glyph.
x
x: undefined | number | GlyphCallback <A, C, number>
A callback to define the pixel x coordinate of the glyph.
y
y: undefined | number | GlyphCallback <A, C, number>
A callback to define the pixel y coordinate of the glyph
zoomFn
zoomFn: undefined | (): void
A callback function that will be passed to the GlyphModifier that will manage the glyphs created with this config. If provided, this callback function will override the GlyphModifier’s zoom method, which typically sets most of the positioning related properties from the GlyphConfig. Don’t use this unless you know what you’re doing.