- 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
LinearGradientBrush
DsPdfJS API / LinearGradientBrush
Class: LinearGradientBrush
Represents a linear gradient brush.
Extends
Constructors
Constructor
new LinearGradientBrush(
linearGradientBrushProperties):LinearGradientBrush
Creates a linear gradient brush with specified properties.
Parameters
linearGradientBrushProperties
The settings for creating a linear gradient brush.
Returns
LinearGradientBrush
Example
const brush = new LinearGradientBrush({
startColor: "ForestGreen",
startPoint: { x: 0, y: 0 },
endColor: "Yellow",
endPoint: { x: 1, y: 0 }
});
Overrides
Brush.constructor
Constructor
new LinearGradientBrush(
om,linearGradientBrushProperties):LinearGradientBrush
Creates a linear gradient brush with specified properties.
Parameters
om
An object manager that controls the lifetime of the LinearGradientBrush object.
linearGradientBrushProperties
The settings for creating a linear gradient brush.
Returns
LinearGradientBrush
Overrides
Brush.constructor
Accessors
endColor
Get Signature
get endColor():
Color
Gets the ending gradient color.
Returns
endPoint
Get Signature
get endPoint():
Point
Gets the end point of the linear gradient brush. (0, 0) is the top-left corner, (1, 1) is the bottom-right corner.
Returns
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
om
Get Signature
get om():
ObjectManager
Gets the owner ObjectManager instance.
Returns
Inherited from
startColor
Get Signature
get startColor():
Color
Gets the starting gradient color.
Returns
startPoint
Get Signature
get startPoint():
Point
Gets the start point of the linear gradient brush. (0, 0) is the top-left corner, (1, 1) is the bottom-right corner.
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