Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IndividualPointFill

Class for enabling individual fill style for point-based Series.

When this is selected as fill style, the Series will allow using PointColors instead of normal *Points when adding data. If *Point is still used, the configurable Fallback Color is used.

Instances of IndividualPointFill are immutable, meaning that its setters don't modify the object, but instead return a completely new modified object.

When creating a new IndividualPointFill object from scratch, parameters can be passed like follows:

  • new IndividualPointFill({ color: ColorHEX('#F00') })

Index

Constructors

constructor

  • When creating a new IndividualPointFill object from scratch, the parameters can be passed like follows:

    • new IndividualPointFill({ color: ColorHEX('#F00') })

    Parameters

    • Optional props: Partial<FillStyleProperties>

      Optional object containing parameters for creation of IndividualPointFill

    Returns IndividualPointFill

Methods

createDefaultHighlightStyle

  • createDefaultHighlightStyle(): this
  • Get automatically computed highlight style.

    Returns this

    Object itself, because the Color information is stored in PointColor

getDefaultHighlightStyle

  • getDefaultHighlightStyle(): this
  • Get automatically computed highlight style.

    Returns this

    FillStyle object

getFallbackColor

  • getFallbackColor(): Color
  • Get Fallback Color of IndividualPointFill.

    Returns Color

    Color object

setFallbackColor

  • setFallbackColor(color: Color): this
  • Construct a new IndividualPointFill object based on this one, but with a modified Fallback Color.

    Example usage:

    Desired result Argument
    Specified Fallback Color ColorHex('#F00')
    Changed transparency (color) => color.setA(80)

    Parameters

    Returns this

    New IndividualPointFill object

Static Record

  • Record(defaultValues: TProps, name?: undefined | string): Factory<TProps>
  • Unlike other types in Immutable.js, the Record() function creates a new Record Factory, which is a function that creates Record instances.

    See above for examples of using Record().

    Note: Record is a factory function and not a class, and does not use the new keyword during construction.

    Type parameters

    • TProps

    Parameters

    • defaultValues: TProps
    • Optional name: undefined | string

    Returns Factory<TProps>