Brush

Properties

• dataKeyString | Number | Function

  Decides how to extract the value of this Brush from the data: - `string`: the name of the field in the data object; - `number`: the index of the field in the data; - `function`: a function that receives the data object and returns the value of this Brush.

• xNumber

  The x-coordinate of brush. If left undefined, it will be computed from the chart's offset and margins.

• yNumber

  The y-coordinate of brush. If left undefined, it will be computed from the chart's offset and margins.

• widthNumber

  The width of brush. If undefined, defaults to the chart width.

• heightNumber

  The height of brush in pixels.

  DEFAULT: 40

• travellerWidthNumber

  The width of each traveller.

  DEFAULT: 5

• gapNumberoptional

  Number of data points to skip between chart refreshes.

  DEFAULT: 1

• startIndexNumberoptional

  The default start index of brush. If the option is not set, the start index will be 0.

• endIndexNumberoptional

  The default end index of brush. If the option is not set, the end index will be calculated by the length of data.

• tickFormatterFunctionoptional

  The formatter function of ticks.

• onChangeFunctionoptional

  The handler of changing the active scope of brush.