- README
- globals
-
classes
- AcroForm
- ActionBase
- ActionFieldsBase
- ActionGoTo
- ActionGoToR
- ActionJavaScript
- ActionJavaScriptMap
- ActionNamed
- ActionResetForm
- ActionSubmitForm
- ActionUnknown
- ActionURI
- AnnotationBase
- AnnotationCollection
- AnnotationPagesCollection
- BilevelBitmap
- Bitmap
- BmpContext
- Border
- BorderEffect
- Brush
- ButtonAppearance
- CaretAnnotation
- CheckBoxField
- ChoiceField
- CircleAnnotation
- ComboBoxField
- CombTextField
- DefaultAppearance
- Destination
- DestinationBase
- DestinationFit
- DestinationFitB
- DestinationFitBH
- DestinationFitBV
- DestinationFitH
- DestinationFitR
- DestinationFitV
- DestinationRef
- DestinationUnknown
- DestinationXYZ
- DocAction
- DocumentDestinations
- DocumentInfo
- DrawingContext
- DsPdf
- DsPdfConfig
- EmbeddedFileStream
- Field
- FieldCollection
- FieldWidgetCollection
- FileAttachmentAnnotation
- FileSpecification
- FileSpecificationMap
- Font
- FontCollection
- FontHandler
- FontHandlerCollection
- Format
- FreeTextAnnotation
- GraphicsPath
- GrayscaleBitmap
- HatchBrush
- Image
- ImageBrush
- InkAnnotation
- Layout
- LineAnnotation
- LinearGradientBrush
- LinkAnnotation
- ListBoxField
- MarkupAnnotation
- Metadata
- ObjectBase
- ObjectManager
- OutlineNode
- OutlineNodeCollection
- PdfContext
- PdfDocument
- PdfImageHandler
- PdfImageHandlerCollection
- PdfPage
- PdfPageCollection
- Pen
- PolygonAnnotation
- PolygonAnnotationBase
- PolyLineAnnotation
- PopupAnnotation
- PushButtonField
- RadialGradientBrush
- RadioButtonField
- RedactAnnotation
- RichMediaAnnotation
- Security
- SecurityHandlerBase
- SignatureField
- SolidBrush
- SoundAnnotation
- SoundObject
- SplitOptions
- SquareAnnotation
- StampAnnotation
- StandardSecurityHandler
- StandardSecurityHandlerRev2
- StandardSecurityHandlerRev3
- StandardSecurityHandlerRev4
- StandardSecurityHandlerRev5
- StandardSecurityHandlerRev6
- SvgContext
- SvgDocument
- TextAnnotation
- TextField
- TextMarkupAnnotation
- Transform
- UnknownAnnotation
- UnknownSecurityHandler
- WatermarkAnnotation
- WidgetAnnotation
- enumerations
- functions
- type-aliases
RadialGradientBrush
DsPdfJS API / RadialGradientBrush
Class: RadialGradientBrush
Represents a radial gradient brush.
Extends
Constructors
Constructor
new RadialGradientBrush(
radialGradientBrushProperties):RadialGradientBrush
Creates a radial gradient brush with specified properties.
Parameters
radialGradientBrushProperties
The settings for creating a radial gradient brush.
Returns
RadialGradientBrush
Overrides
Brush.constructor
Constructor
new RadialGradientBrush(
om,radialGradientBrushProperties):RadialGradientBrush
Creates a radial gradient brush with specified properties.
Parameters
om
An object manager that controls the lifetime of the RadialGradientBrush object.
radialGradientBrushProperties
The settings for creating a radial gradient brush.
Returns
RadialGradientBrush
Overrides
Brush.constructor
Accessors
centerOfEndCircle
Get Signature
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
centerOfStartCircle
Get Signature
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
endColor
Get Signature
get endColor():
Color
Gets the ending gradient color.
Returns
extendEndCircle
Get Signature
get extendEndCircle():
boolean
Gets a value indicating whether to extend gradient beyond the end circle.
Returns
boolean
extendStartCircle
Get Signature
get extendStartCircle():
boolean
Gets a value indicating whether to extend the gradient beyond the start circle.
Returns
boolean
gradientStops
Get Signature
get gradientStops():
GradientStop[] |null
Gets the array of gradient stops.
Returns
GradientStop[] | null
id
Get Signature
get id():
number
Gets the reference to the object.
Returns
number
Inherited from
normalize
Get Signature
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
om
Get Signature
get om():
ObjectManager
Gets the owner ObjectManager instance.
Returns
Inherited from
radiusOfEndCircle
Get Signature
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
radiusOfStartCircle
Get Signature
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
startColor
Get Signature
get startColor():
Color
Gets the starting gradient color.
Returns
type
Get Signature
get type():
BrushType
Gets the type of the brush.
Returns
Overrides
Methods
free()
free():
void
Detaches the object from the ObjectManager and deallocates its memory, if possible.
Returns
void
Inherited from
rebind()
rebind(
omTo):void
Rebinds the object from the current ObjectManager to the specified one.
Parameters
omTo
The new ObjectManager for the object.
Returns
void