Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BaseGridComponent

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • new BaseGridComponent(grid: Grid, x?: number, y?: number, width?: number, height?: number): BaseGridComponent

  • Parameters

    • grid: Grid
    • Default value x: number = 0

      relative to grid

    • Default value y: number = 0

      relative to grid

    • Default value width: number = 0
    • Default value height: number = 0

    Returns BaseGridComponent

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

Protected grid

grid: Grid

Protected gridManager

gridManager: GridManager

height

height: number

component height

margin

margin: Margin = new Margin()

Margin in pixels (space reserved out of the 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[]}

padding

padding: Padding = new Padding()

Padding on grid (space inside grid before start)

type

{VobcoCharts.Settings.Padding}

width

width: number

component width

x

x: number

X position on chart

y

y: number

Y position on chart

Methods

draw

  • draw(): void

isMouseOnComponent

  • isMouseOnComponent(): boolean

  • Returns true if mouse cursor is on this component

    Returns boolean

Generated using TypeDoc