Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class PlotArea

Represents the area in which the chart series is plotted.

Hierarchy

Hierarchy (view full)

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

$type

$type: Type

Static $t

$t: Type

Static nextHashCode

nextHashCode: number

Accessors

border

  • get border(): ChartBorder

  • Determines the appearance of the border drawn around the chart element area, as well as whether a border appears.

    Returns ChartBorder

  • set border(a): void

  • Parameters

    Returns void

chart

  • get chart(): WorksheetChart

  • Returns the owning chart (read-only)

    See

    [[owner]]

    Returns WorksheetChart

fill

  • get fill(): ChartFillBase

  • Returns or sets a [[ChartFillBase]] derived object which defines the fill properties for the chart element area.

    This property returns null by default, indicating that no fill is applied.

    To apply a solid color fill, assign an instance of the [[ChartSolidFill]] class to this property.

    To apply a gradient fill, assign an instance of the [[ChartGradientFill]] class to this property.

    To make the area transparent, assign an instance of the [[ChartEmptyFill]] class to this property.

    See

    • [[ChartSolidFill]]
    • [[ChartGradientFill]]
    • [[ChartEmptyFill]]

    Returns ChartFillBase

  • set fill(a): void

  • Parameters

    Returns void

height

  • get height(): number

  • Returns or sets the height of the area, expressed as a fraction of the height of the containing chart element.

    See

    • [[width]]
    • [[top]]
    • [[height]]

    Returns number

  • set height(a): void

  • Parameters

    • a: number

    Returns void

left

  • get left(): number

  • Returns or sets a value which represents the left edge of the area, expressed as a fraction of the width of the containing chart element.

    This property can be set to a value between zero and one, where one represents the total width of the containing element.

    For example, to situate the area such that it's left edge coincides with the center of the containing element, set this property to .5.

    See

    • [[top]]
    • [[width]]
    • [[height]]

    Returns number

  • set left(a): void

  • Parameters

    • a: number

    Returns void

owner

  • get owner(): ChartObject

  • returns this object's owner. (read-only) The owner or null if this object is owned directly by the Chart

    See

    [[chart]]

    Returns ChartObject

position

  • get position(): ElementPosition

  • Returns or sets the position of the plot area on the chart.

    Returns ElementPosition

  • set position(a): void

  • Parameters

    Returns void

roundedCorners

  • get roundedCorners(): boolean

  • Detrmines if the chart area is displayed with rounded corners

    Returns boolean

  • set roundedCorners(a): void

  • Parameters

    • a: boolean

    Returns void

sheet

  • get sheet(): Sheet

  • The owning sheet (read-only)

    Returns Sheet

top

  • get top(): number

  • Returns or sets a value which represents the top edge of the area, expressed as a fraction of the height of the containing chart element.

    This property can be set to a value between zero and one, where one represents the total height of the containing element.

    For example, to situate the area such that it's top edge coincides with the center of the containing element, set this property to .5.

    See

    • [[left]]
    • [[width]]
    • [[height]]

    Returns number

  • set top(a): void

  • Parameters

    • a: number

    Returns void

width

  • get width(): number

  • Returns or sets the width of the area, expressed as a fraction of the width of the containing chart element.

    See

    • [[height]]
    • [[top]]
    • [[height]]

    Returns number

  • set width(a): void

  • Parameters

    • a: number

    Returns void

workbook

  • get workbook(): Workbook

  • The owning workbook (read-only)

    Returns Workbook

worksheet

  • get worksheet(): Worksheet

  • The owning worksheet (read-only)

    Returns Worksheet

Methods

equals

  • equals(other): boolean

  • Parameters

    • other: any

    Returns boolean

getHashCode

  • getHashCode(): number

  • Returns number

memberwiseClone

  • memberwiseClone(): Base

  • Returns Base

Static compare

  • compare(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static compareSimple

  • compareSimple(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static equalsSimple

  • equalsSimple(item1, item2): boolean

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

Static equalsStatic

  • equalsStatic(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static getArrayOfProperties

  • getArrayOfProperties(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getArrayOfValues

  • getArrayOfValues(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getHashCodeStatic

  • getHashCodeStatic(obj): number

  • Parameters

    • obj: any

    Returns number

Static referenceEquals

  • referenceEquals(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static staticInit

  • staticInit(): void

  • Returns void