Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Constructors

constructor

  • new Grid(chart: Chart, height: number, position?: number): Grid
  • Parameters

    • chart: Chart
    • height: number
    • Default value position: number = null

    Returns Grid

Properties

chart

chart: Chart

Reference to chart

components

components: Array<IComponent>

Child components array

cursor

cursor: string = "default"

Mouse arrow when mouse is over this component

height

height: number

component height

indicators

indicators: Array<GridIndicator>

margin

margin: Margin = new Margin()

Margin in pixels (space reserved out of the grid, )

max

max: number

Maximum value that can be displayed on grid

min

min: number

Minimum value that can be displayed on grid

onClick

onClick: Function

On click callback

type

{Function}

onMouseMove

onMouseMove: Function

On mouse move callback

type

{Function[]}

onMouseOver

onMouseOver: Function

On mouse over callback

type

{Function[]}

originalHeight

originalHeight: number

padding

padding: Padding = new Padding()

Padding on grid (space inside grid before start)

type

{VobcoCharts.Settings.Padding}

settings

settings: Grid

width

width: number

component width

x

x: number

X position on chart

y

y: number

Y position on chart

yAxis

yAxis: YAxis

y axis numbers

Methods

addIndicator

  • Adds indicator to grid

    Parameters

    Returns void

draw

  • draw(): void

Protected drawResizeTriangles

  • drawResizeTriangles(drawUtils: IDrawUtils): void
  • Parameters

    Returns void

drawX

  • drawX(): void
  • Draw X grid

    Returns void

drawY

  • drawY(): void
  • Draw Y grid lines

    Returns void

Protected getInputIndicatorData

  • Parameters

    Returns number[]

getMouseYPositionOnGrid

  • getMouseYPositionOnGrid(): number
  • Get current Y position on grid

    Returns number

getYFromValue

  • getYFromValue(value: number): number
  • returns absolute y position based on value passec

    Parameters

    • value: number

    Returns number

isMouseOnComponent

  • isMouseOnComponent(): boolean
  • Returns true if mouse cursor is on this component

    Returns boolean

recalculateIndicators

  • recalculateIndicators(): void
  • Recalculate all indicators on chart

    Returns void

Protected setGridMinMax

  • setGridMinMax(): void
  • Returns void

Protected setYAxis

  • setYAxis(fixedMin?: boolean, fixedMax?: boolean): void
  • Calculate grid y axis data

    Parameters

    • Default value fixedMin: boolean = false
    • Default value fixedMax: boolean = false

    Returns void

Generated using TypeDoc