Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IndividualPointFill

Style class for describing a individually configured fill color, enabling users to specify data-point specific colors.

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

Properties of IndividualPointFill:

  • color: fallback color to be used with data points that were not associated with a color. Construct a LCJS color using one of the many available factories:

IndividualPointFill Usage:

IndividualPointFill can be used with a select group of series:

 // Example, individual points fill color.
 PointSeries.setPointFillStyle(new IndividualPointFill())

Related information:

For more fill styles, see:

Index

Constructors

constructor

  • Construct a IndividualPointFill object, specifying any amount of its properties.

     // Example, for most cases no arguments are necessary (fallback color will be black).
     const individualPointFill = new IndividualPointFill()
     // Example, specify fallback color for data points without associated color.
     const individualPointFill = new IndividualPointFill({
         color: ColorRGBA( 0, 255, 0 )
     })

    Parameters

    Returns IndividualPointFill

Methods

getDefaultHighlightStyle

  • getDefaultHighlightStyle(): this

getFallbackColor

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

    Returns Color

    Color object

setFallbackColor

  • Construct a new IndividualPointFill object based on this one, but with modified fallback color.

    Example:

    // specify new color
    individualfill.setColor( ColorHEX('#F00') )
    
    // change individual color properties
    individualfill.setColor( color => color.setA(80) )

    Parameters

    • value: Color | ImmutableMutator<Color>

      Either a Color object or a function, which will be used to create a new Color based on current value.

    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
    • name: undefined | string

    Returns Factory<TProps>