Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Thickness

Go to JavaScript Charting Documentation
Go to JavaScript Chart Examples
Go to SciChart.js on Github

Hierarchy

  • Thickness

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Thickness(top: number, right?: number, bottom?: number, left?: number): Thickness

  • Creates an instance of a Thickness object, with top, right, bottom and left

    The constructor shortcuts are as follows:

    new Thickness(3, 5, 3, 5)    // all defined
new Thickness(3, 5, 3)       // left undefined -> copies right
new Thickness(3, 5)          // left & bottom undefined -> copies right & top respectively
new Thickness(3)            // all sides equal to 3

    Parameters

    • top: number
    • Optional right: number
    • Optional bottom: number
    • Optional left: number

    Returns Thickness

Properties

bottom

bottom: number

Gets or sets the bottom amount

left

left: number

Gets or sets the left amount

right

right: number

Gets or sets the right amount

top

top: number

Gets or sets the top amount

Methods

Static areEqual

  • Returns whether two Thickness instances are equal or not

    example

    const t1 = new Thickness(4,4,4,4); const t2 = new Thickness.fromNumber(4); console.log(Thickness.areEqual(t1, t2)); // True

    Parameters

    Returns boolean

Static fromNumber

  • Creates a Thickness (margin or padding) from a single value, e.g. 10, would return a thickness with top, right, bottom left = 10

    Parameters

    • value: number

    Returns Thickness

Static fromString

  • Creates a Thickness (margin or padding) from string, e.g. "25 50 75 100". Order is top, right, bottom left. Same as in Css

    Parameters

    • str: string

    Returns Thickness

Static mergeAdd

  • Returns the sum of each side of 2 components in a new Thickness object

    example

    const t1 = new Thickness(1,2,3,4); const t2 = new Thickness(4,3,2,1); console.log(Thickness.mergeAdd(t1, t2)); // Thickness { top: 5, right: 5, bottom: 5, left: 5 }

    Parameters

    Returns Thickness

Static mergeMax

  • Returns the max of each side of 2 components in a new Thickness object

    example

    const t1 = new Thickness(1,2,3,4); const t2 = new Thickness(4,3,2,1); console.log(Thickness.mergeMax(t1, t2)); // Thickness { top: 4, right: 3, bottom: 3, left: 4 }

    Parameters

    Returns Thickness

Static mergeSubtract

  • Returns the difference of each side of 2 components in a new Thickness object

    example

    const t1 = new Thickness(1,2,3,4); const t2 = new Thickness(4,3,2,1); console.log(Thickness.mergeSubtract(t1, t2)); // Thickness { top: -3, right: -1, bottom: 1, left: 3 }

    Parameters

    Returns Thickness

Generated using TypeDoc