Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • _Guide
    • Guide

Index

Constructors

constructor

  • Returns Guide

Properties

above

above: boolean

If you set it to true, the guide will be displayed above the graphs.

angle

angle: number

Radar chart only. Specifies angle at which guide should start. Affects only fills, not lines.

balloonColor

balloonColor: string

Baloon fill color.

balloonText

balloonText: string

The text which will be displayed if the user rolls-over the guide.

boldLabel

boldLabel: boolean

Specifies if label should be bold or not.

category

category: string

Category of the guide (in case the guide is for category axis).

dashLength

dashLength: number

Dash length.

date

date: Date

Date of the guide (in case the guide is for category axis and parseDates is set to true).

expand

expand: boolean

Works if a guide is added to CategoryAxis and this axis is non-date-based. If you set it to true, the guide will start (or be placed, if it's not a fill) on the beginning of the category cell and will end at the end of toCategory cell.

fillAlpha

fillAlpha: number

Fill opacity. Value range is 0 - 1.

fillColor

fillColor: string

Fill color.

fontSize

fontSize: string

Font size of guide label.

id

id: string

Unique id of a Guide. You don't need to set it, unless you want to.

inside

inside: boolean

Specifies whether label should be placed inside or outside plot area.

label

label: string

The label which will be displayed near the guide.

labelRotation

labelRotation: number

Rotation angle of a guide label.

lineAlpha

lineAlpha: number

Line opacity.

lineColor

lineColor: string

Line color.

lineThickness

lineThickness: number

Line thickness.

position

position: string

Position of guide label. Possible values are "left" or "right" for horizontal axis and "top" or "bottom" for vertical axis.

tickLength

tickLength: number

Tick length.

toAngle

toAngle: number

Radar chart only. Specifies angle at which guide should end. Affects only fills, not lines.

toCategory

toCategory: string

To category of the guide (in case the guide is for category axis).

toDate

toDate: Date

To date of the guide (in case the guide is for category axis and parseDates is set to true). If you have both date and toDate, the space between these two dates can be filled with color.

toValue

toValue: number

To value of the guide (in case the guide is for value axis).

value

value: number

Value of the guide (in case the guide is for value axis).

valueAxis

valueAxis: default

Value axis of a guide. As you can add guides directly to the chart, you might need to specify which which value axis should be used.

Generated using TypeDoc