Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SolidFill

Style class for describing a solid fill color.

Instances of SolidFill, 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 SolidFill:

SolidFill Usage:

Use SolidFill with:

 // Example, style points fill with solid red color.
 PointSeries.setPointFillStyle(new SolidFill({
     color: ColorRGBA( 255, 0, 0 )
 }))
  • Creating a SolidLine, or other line style, which can be used for styling a stroke, or border.

Watch out! A common misuse is to attempt styling strokes or borders directly using fill style or color. Remember, when calling a setStrokeStyle method, a line style is expected! Carefully observe the order of wrapped styles: line style <- fill style <- color

 // Example, style line series stroke with solid red line.
 LineSeries.setStrokeStyle(new SolidLine({
     thickness: 1,
     fillStyle: new SolidFill({ color: ColorRGBA( 255, 0, 0 ) })
 }))

Related information:

For more fill styles, see:

Index

Constructors

constructor

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

     // Example using RGBA color factory.
     const solidRed = new SolidFill({
         color: ColorRGBA( 255, 0, 0 )
     })
    
     // Example using HEX color factory.
     const solidRed = new SolidFill({
         color: ColorHEX( '#ff0000' )
     })
    

    Parameters

    Returns SolidFill

Properties

Readonly type

type : "fillstyle"

Methods

getColor

  • Get color of SolidFill.

    Returns Color

    Color object

getDefaultHighlightStyle

  • getDefaultHighlightStyle(): this

setA

  • Construct a new SolidFill object based on this one, but with a modified Alpha value.

    Parameters

    • alpha: number

      Value of Alpha channel [0-255]

    Returns SolidFill

    New SolidFill object

setB

  • Construct a new SolidFill object based on this one, but with a modified Blue value.

    Parameters

    • blue: number

      Value of Blue channel [0-255]

    Returns SolidFill

    New SolidFill object

setColor

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

    Example:

    // specify new color
    solidfill.setColor( ColorHEX('#F00') )
    
    // change individual color properties
    solidfill.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 SolidFill object

setG

  • Construct a new SolidFill object based on this one, but with a modified Green value.

    Parameters

    • green: number

      Value of Green channel [0-255]

    Returns SolidFill

    New SolidFill object

setR

  • Construct a new SolidFill object based on this one, but with a modified Red value.

    Parameters

    • red: number

    Returns SolidFill

    New SolidFill 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>