API / geotoolkit / attributes / LinearGradientStyle / LinearGradientStyle
attributes.LinearGradientStyle.LinearGradientStyle
Defines a linear gradient fill style to provide smooth transitions between two or more specified colors.
↳
LinearGradientStyle
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
color | string | Color in CSS form |
colorprovider | ColorProvider | ColorProvider |
colorprovider-max | number | |
colorprovider-min | number | |
colorprovider-scale | KnownScales | |
endcolor | string | End color in CSS format |
endpoint | Point | End point of gradient in relative form, 0-1 or absolute coordinates |
endpoint-x | number | X coordinate |
endpoint-y | number | Y coordinate |
evenoddmode | boolean | Even-odd fill mode |
fillpattern | Pattern | Pattern |
fillpattern-containername | string | An optional container name, which creates an image pattern. This parameter is used for serialization if you want to save are reference to pattern instead of the pattern itself |
fillpattern-patternname | string | Name of this pattern for indexing |
fillpattern-scalable | boolean | Flag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported) |
foreground | string | Foreground color |
pattern | Pattern | Pattern |
spreadmethod | SpreadMethods | Spread method defines how the gradient fills given area if gradient vector does not cover the whole area |
startcolor | string | Start color in CSS format |
startpoint | Point | Start point of gradient in relative form, 0-1 or absolute coordinates |
transformation | Transformation | Gradient transformation |
transformation-dx | number | X axis translation |
transformation-dy | number | Y axis translation |
transformation-xx | number | X scale |
transformation-xy | number | Xy skew |
transformation-yx | number | Yx skew |
transformation-yy | number | Y scale |
unittype | GradientUnits | Type of coordinated used to define gradient |
Constructors
• new LinearGradientStyle(startColor?, endColor?, startPoint?, endPoint?, colorProvider?, spreadMethod?, unitType?, transformation?)
Create LinearGradientStyle
| Name | Type | Description |
|---|---|---|
Optional startColor | string | Options | start color in CSS format or JSON with parameters |
Optional endColor | string | end color in CSS format |
Optional startPoint | Point | Options | start point of gradient in relative form, 0-1 or absolute coordinates |
Optional endPoint | Point | Options | end point of gradient in relative form, 0-1 or absolute coordinates |
Optional colorProvider | ColorProvider | colorProvider |
Optional spreadMethod | "repeat" | "reflect" | "pad" | SpreadMethods | Spread method defines how the gradient fills given area if gradient vector does not cover the whole area |
Optional unitType | string | Type of coordinated used to define gradient |
Optional transformation | Transformation | Gradient transformation |
GradientStyle.constructor
Accessors
• Static get Empty(): FillStyle
Empty style
GradientStyle.Empty
• Static get Pick(): FillStyle
Pick style
GradientStyle.Pick
Methods
▸ addStopPoint(position, color): LinearGradientStyle
Add a new stop point at a given position and color.
| Name | Type | Description |
|---|---|---|
position | number | position of the stop point, if in relative coordinates from 0 to 1 |
color | string | color in CSS form for specified stop point |
this
▸ cleanDuplicatePoints(): LinearGradientStyle
Removes points that are identical, leaving only one
this
GradientStyle.cleanDuplicatePoints
▸ clearStopPoints(): LinearGradientStyle
Clear all stop points
this
▸ clone(): LinearGradientStyle
All inheritors should implement copy constructor or provide custom implementation for this method
this
▸ Protected copyConstructor(src, deepCopy?): LinearGradientStyle
copy constructor
| Name | Type | Description |
|---|---|---|
src | LinearGradientStyle | Source to copy from |
Optional deepCopy | boolean | deep copy |
this
▸ dispose(): void
Dispose.
void
▸ equalsTo(other): boolean
Returns true if fills are identical
| Name | Type | Description |
|---|---|---|
other | FillStyle | FillStyle to compare against |
boolean
▸ getClassName(): string
string
▸ getColor(): string
Returns color
string
color in CSS form
▸ getEndColor(): string
Returns end color
string
color color in CSS format
▸ getEndPoint(): Point
Return end point from 0 to 1
end point
▸ getEvenOddMode(): boolean
Gets the even odd fill mode
boolean
evenOddMode The even odd fill mode flag.
▸ getForegroundColor(): string
Gets foreground color
string
color in CSS form
GradientStyle.getForegroundColor
▸ getPattern(context?): any
Return fill pattern. Can pass in rendering context to get HTML DOM pattern, or no arguments to get fillPattern object.
| Name | Type | Description |
|---|---|---|
Optional context | IPatternContext | native rendering context |
any
image pattern
▸ getProperties(): OptionsOut
Gets all the properties pertaining to this object
An object containing the properties to set
▸ getRaster(xMin?, yMin?, xMax?, yMax?): Raster
Returns a new instance of Raster
| Name | Type | Description |
|---|---|---|
Optional xMin | number | x Min position to get color |
Optional yMin | number | y Min position to get color |
Optional xMax | number | x Max position to get color |
Optional yMax | number | y Max position to get color |
▸ getRgbaColor(): RgbaColor
Return RGBA color
color
▸ getShadow(): Shadow
Gets all properties pertaining to shadow
JSON with offsetX, offsetY, color and blur properties
▸ getSpreadMethod(): SpreadMethods
▸ getStartColor(): string
Returns start color
string
color in CSS format
▸ getStartPoint(): Point
Return start point from 0 to 1
point
▸ getStopPointColor(index): string
Return color at a stop point by index.
| Name | Type | Description |
|---|---|---|
index | number | index of a stop point |
string
color in CSS format, or null if index is out of range.
GradientStyle.getStopPointColor
▸ getStopPointPosition(index): number
Return stop point position
| Name | Type | Description |
|---|---|---|
index | number | index of stop point |
number
position either in relative or absolute terms or null if index is out of range.
GradientStyle.getStopPointPosition
▸ getStopPointsCount(): number
Return the number of defined gradient stop points
number
stops number of stops
GradientStyle.getStopPointsCount
▸ getStyleType(): string
Return type of the style.
string
STYLE_TYPE_LINEAR_GRADIENT
▸ getTimeStamp(): number
Gets time stamp
number
timeStamp
▸ getTransformation(): Transformation
Returns the transformation set on the gradient
GradientStyle.getTransformation
▸ getUnits(): GradientUnits
Gets the type of units
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
GradientStyle.hasEventListener
▸ invalidate(): LinearGradientStyle
notify the node that the style is invalidated
this
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ notify<E>(type, source, args?): LinearGradientStyle
Notify listeners
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | event types |
source | Style | of the event |
Optional args | EventMap[E] | arguments of the event |
this
▸ off<E>(type, callback?): LinearGradientStyle
Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of the event |
Optional callback | (eventType: E, sender: LinearGradientStyle, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): LinearGradientStyle
Attach listener on event that will be called whenever the specified event is delivered to the target
If the callback function is already in the list of event listeners for this target, the function is not added a second time.
If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: LinearGradientStyle, args: EventMap[E]) => void | to be called |
this
▸ removeStopPoint(index): LinearGradientStyle
Removes stop point at index.
| Name | Type | Description |
|---|---|---|
index | number | index of the stop point |
this
▸ setColor(color): LinearGradientStyle
Sets color
| Name | Type | Description |
|---|---|---|
color | string | RgbaColor | HsvColor | HlsColor | in CSS string form or RgbaColor object |
this
▸ setEndColor(color): LinearGradientStyle
Sets end color
| Name | Type | Description |
|---|---|---|
color | string | color to set in CSS format |
this
▸ setEndPoint(p): LinearGradientStyle
Set end point from 0 to 1
| Name | Type | Description |
|---|---|---|
p | Point | end point |
this
▸ setEvenOddMode(evenOddMode): LinearGradientStyle
Sets the even odd fill mode
| Name | Type | Description |
|---|---|---|
evenOddMode | boolean | The even odd fill mode flag. |
this
▸ setForegroundColor(color): LinearGradientStyle
Sets foreground color
this
GradientStyle.setForegroundColor
▸ setPattern(pattern?): LinearGradientStyle
Sets fill pattern.
| Name | Type | Description |
|---|---|---|
Optional pattern | Pattern | fill pattern |
this
▸ setProperties(properties?): LinearGradientStyle
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options | An object containing the properties to set |
▸ setShadow(shadow): LinearGradientStyle
Sets all properties pertaining to shadow
this
▸ setSilent(bool, force?): LinearGradientStyle
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
Optional force | boolean | true if parent should be invalidated immediately |
this
▸ setSpreadMethod(sMethod): LinearGradientStyle
Changes spread method for the gradient
| Name | Type | Description |
|---|---|---|
sMethod | "repeat" | "reflect" | "pad" | SpreadMethods | Spread method to apply to the gradient |
this
▸ setStartColor(color): LinearGradientStyle
Sets start color
| Name | Type | Description |
|---|---|---|
color | string | color to set |
this
▸ setStartPoint(p): LinearGradientStyle
Set start point from 0 to 1
| Name | Type | Description |
|---|---|---|
p | Point | start point |
this
▸ setStopPointColor(index, color): LinearGradientStyle
Sets color to a stop point by index.
| Name | Type | Description |
|---|---|---|
index | number | index of a stop point |
color | string | Color to set to the stop point |
GradientStyle.setStopPointColor
▸ setTransformation(transform): LinearGradientStyle
Sets transformation for the gradient
| Name | Type | Description |
|---|---|---|
transform | Transformation | The new gradient transformation |
GradientStyle.setTransformation
▸ setUnits(u): LinearGradientStyle
Sets unit type for the gradient
| Name | Type | Description |
|---|---|---|
u | GradientUnits | Unit type |
this
▸ toGrayScale(clone?): FillStyle
Clone the instance in grayscale style, or convert itself if [clone] is false.
| Name | Type | Description |
|---|---|---|
Optional clone | boolean | clone instance if true, default is true |
▸ updateTimeStamp(silent?): LinearGradientStyle
Update time stamp to indicate that style has been changed.
| Name | Type | Description |
|---|---|---|
Optional silent | boolean | silent mode. If this parameter equals to true then style doesn't send invalidate event |
this
▸ Static getClassName(): string
string
▸ Static isStyleNotificationEnabled(): boolean
Return status of the global notification for all styles.
boolean