Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PieSegment

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

Hierarchy

  • PieSegment

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    Returns PieSegment

Properties

Readonly id

id: string

Accessors

color

  • get color(): string
  • set color(value: string): void

  • The color of the segment as an HTML color code

    Returns string

  • The color of the segment as an HTML color code

    Parameters

    • value: string

    Returns void

colorLinearGradient

  • An optional color gradient

    Returns GradientParams

  • An optional color gradient

    Parameters

    Returns void

delta

  • get delta(): number
  • set delta(value: number): void

  • The amount to shift the segment when it is selected. Default 15 px

    Returns number

  • The amount to shift the segment when it is selected. Default 15 px

    Parameters

    • value: number

    Returns void

isSelected

  • get isSelected(): boolean
  • set isSelected(value: boolean): void

  • Whether the segment is selected. Selected segments are shifted outwards by the delta

    Returns boolean

  • Whether the segment is selected. Selected segments are shifted outwards by the delta

    Parameters

    • value: boolean

    Returns void

labelOffset

  • get labelOffset(): Point
  • set labelOffset(value: Point): void

  • An x, y offset for the label position

    Returns Point

  • An x, y offset for the label position

    Parameters

    Returns void

labelProvider

  • Optional class that can override the default label formatting for this segment only. Must be or inherit from PieLabelProvider

    Returns PieLabelProvider

  • Optional class that can override the default label formatting for this segment only. Must be or inherit from PieLabelProvider

    Parameters

    Returns void

labelStyle

  • Gets or sets a TTextStyle object for styling labels for this segment only

    Returns TTextStyle

  • Gets or sets a TTextStyle object for styling labels for this segment only

    Parameters

    Returns void

oldValue

  • get oldValue(): number

  • The previous value of the segment, if it has been updated. Used for animations

    Returns number

radiusAdjustment

  • get radiusAdjustment(): number
  • set radiusAdjustment(value: number): void

  • A relative adjustment of the radius for this segment. eg 1.5 will be 50% larger than normal

    Returns number

  • A relative adjustment of the radius for this segment. eg 1.5 will be 50% larger than normal

    Parameters

    • value: number

    Returns void

shift

  • get shift(): number
  • set shift(value: number): void

  • The amount the segment is shifted radially outwards. Automatically set during selected/deselection animations Do not set this directly. Use delta and isSelected instead

    Returns number

  • The amount the segment is shifted radially outwards. Automatically set during selected/deselection animations

    Parameters

    • value: number

    Returns void

text

  • get text(): string
  • set text(value: string): void

  • A text value for the segment which will be displayed in the legend

    Returns string

  • A text value for the segment which will be displayed in the legend

    Parameters

    • value: string

    Returns void

value

  • get value(): number
  • set value(value: number): void

  • The numerical value of the segment

    Returns number

  • The numerical value of the segment

    Parameters

    • value: number

    Returns void

Methods

getLabelText

  • getLabelText(total: number): string

  • Parameters

    • total: number

    Returns string

getPercentage

  • getPercentage(total: number): number

  • Parameters

    • total: number

    Returns number

onAttach

onDetach

  • onDetach(): void

  • Returns void

toJSON

Generated using TypeDoc