DsPdfJS API - v9.1.0
    Preparing search index...

    Class RadialGradientBrush

    Represents a radial gradient brush.

    Hierarchy (View Summary)

    Index

    Constructors

    Accessors

    • get centerOfEndCircle(): Point

      Gets the center of the end circle that defines the end of the gradient. (0, 0) is the top-left corner, (1, 1) is the bottom-right corner.

      Returns Point

    • get centerOfStartCircle(): Point | null

      Gets the center of the start circle that defines the beginning of the gradient. (0, 0) is the top-left corner, (1, 1) is the bottom-right corner. If not specified, the center of the start circle coincides with RadialGradientBrush.centerOfEndCircle.

      Returns Point | null

    • get endColor(): Color

      Gets the ending gradient color.

      Returns Color

    • get extendEndCircle(): boolean

      Gets a value indicating whether to extend gradient beyond the end circle.

      Returns boolean

    • get extendStartCircle(): boolean

      Gets a value indicating whether to extend the gradient beyond the start circle.

      Returns boolean

    • get id(): number

      Gets the reference to the object.

      Returns number

    • get normalize(): boolean

      Gets a value indicating whether to normalize the brush ensuring that it renders the same way on all supported target contexts (such as PdfContext, BmpContext, and SvgContext). If true, and the focal point is outside the end circle, it is moved to be on the end circle. If false, the focal point position is not adjusted if it is outside the end circle, and the result will depend on the implementation of the target DrawingContext.

      Returns boolean

    • get radiusOfEndCircle(): number | null

      Gets the radius of the end circle that defines the end of the gradient, as a fraction of the normalized diagonal. The normalized diagonal length is calculated as sqrt(width * width + height * height) / 2. If not specified, the end radius is equal to max(width, height) / 2.

      Returns number | null

    • get radiusOfStartCircle(): number

      Gets the radius of the start circle that defines the beginning of the gradient, as a fraction of the normalized diagonal. The normalized diagonal length is calculated as sqrt(width * width + height * height) / 2.

      Returns number

    • get startColor(): Color

      Gets the starting gradient color.

      Returns Color

    Methods

    • Detaches the object from the ObjectManager and deallocates its memory, if possible.

      Returns void