API / geotoolkit / attributes / GradientStyle / GradientStyle
attributes.GradientStyle.GradientStyle
Defines an abstract gradient fill style. It contains information about gradient stops and colors.
↳
GradientStyle
Constructors
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
color | string | Color in CSS form |
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 |
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 GradientStyle(color?, pattern?, foreground?, evenoddmode?, spreadMethod?, unitType?, transformation?)
Create GradientStyle
| Name | Type | Description |
|---|---|---|
Optional color | string | RgbaColor | Options | Color of FillStyle (not used in Gradient) or JSON with parameters |
Optional pattern | Pattern | The background pattern (not used in Gradient) |
Optional foreground | string | RgbaColor | The foreground color of the pattern (not used in Gradient) |
Optional evenoddmode | boolean | The flag indicating whether even-odd fill mode is to be used. |
Optional spreadMethod | string | 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 |
FillStyle.constructor
Accessors
• Static get Empty(): FillStyle
Empty style
FillStyle.Empty
• Static get Pick(): FillStyle
Pick style
FillStyle.Pick
Methods
▸ addStopPoint(position, color): GradientStyle
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(): GradientStyle
Removes points that are identical, leaving only one
this
▸ clearStopPoints(): GradientStyle
Clear all stop points
this
▸ clone(): GradientStyle
All inheritors should implement copy constructor or provide custom implementation for this method
this
▸ Protected copyConstructor(src, deepCopy?): GradientStyle
copy constructor
| Name | Type | Description |
|---|---|---|
src | GradientStyle | 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
▸ 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
▸ 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
properties
▸ 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
▸ 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.
▸ 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.
▸ getStopPointsCount(): number
Return the number of defined gradient stop points
number
stops number of stops
▸ getStyleType(): string
Returns style type
string
STYLE_TYPE_GRADIENT
▸ getTimeStamp(): number
Gets time stamp
number
timeStamp
▸ getTransformation(): Transformation
Returns the transformation set on the gradient
▸ 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
▸ invalidate(): GradientStyle
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?): GradientStyle
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?): GradientStyle
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: GradientStyle, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): GradientStyle
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: GradientStyle, args: EventMap[E]) => void | to be called |
this
▸ removeStopPoint(index): GradientStyle
Removes stop point at index.
| Name | Type | Description |
|---|---|---|
index | number | index of the stop point |
this
▸ setColor(color): GradientStyle
Sets color
| Name | Type | Description |
|---|---|---|
color | string | RgbaColor | HsvColor | HlsColor | in CSS string form or RgbaColor object |
this
▸ setEvenOddMode(evenOddMode): GradientStyle
Sets the even odd fill mode
| Name | Type | Description |
|---|---|---|
evenOddMode | boolean | The even odd fill mode flag. |
this
▸ setForegroundColor(color): GradientStyle
Sets foreground color
this
▸ setPattern(pattern?): GradientStyle
Sets fill pattern.
| Name | Type | Description |
|---|---|---|
Optional pattern | Pattern | fill pattern |
this
▸ setProperties(properties?): GradientStyle
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options | An object containing the properties to set |
this
▸ setShadow(shadow): GradientStyle
Sets all properties pertaining to shadow
this
▸ setSilent(bool, force?): GradientStyle
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): GradientStyle
Changes spread method for the gradient
| Name | Type | Description |
|---|---|---|
sMethod | "repeat" | "reflect" | "pad" | SpreadMethods | Spread method to apply to the gradient |
this
▸ setStopPointColor(index, color): GradientStyle
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 |
▸ setTransformation(transform): GradientStyle
Sets transformation for the gradient
| Name | Type | Description |
|---|---|---|
transform | Transformation | The new gradient transformation |
▸ setUnits(u): GradientStyle
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?): GradientStyle
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