API / geotoolkit / welllog / attributes / LogDataStyle / LogDataStyle
attributes.LogDataStyle.LogDataStyle
Defines the abstract log data fill style. This fill style can use a data source to create gradient colors. Additionally, it supports two optional layers: a background fill and a foreground fill. The background fill is rendered behind the main fill, while the foreground fill is rendered in front of it. It is generally recommended to enable either the foreground or the background fill, but not both simultaneously. While it is possible to render both the background and foreground fills together, they will share the same colors.
Example
<caption>How to render gradient with background<caption>
const colorProvider = new DiscreteGradientColorProvider({'bins': 255})
.setScale(scale, 0, 1);
const style = new LogGradientStyle()
.setColorProvider(colorProvider)
.setLogData(curve.getDataSource());
style.setColor('#757575')
.setPattern(pattern)
.setRenderBackground(true)
.setTransparency(150);
*@example <caption>How to render gradient with foreground<caption>
const colorProvider = new DiscreteGradientColorProvider({'bins': 255})
.setScale(scale, 0, 1);
const style = new LogGradientStyle()
.setColorProvider(colorProvider)
.setLogData(curve.getDataSource());
style.setColor('#757575')
.setColor(KnownColors.Transparent)
.setForegroundColor('#757575')
.setPattern(pattern)
.setRenderForeground(true);↳
LogDataStyle
Constructors
| [new LogDataStyle(color)](/solutions/geotoolkit/apis/classes/geotoolkit.welllog.attributes-1.logdatastyle.logdatastyle.md#new logdatastyle(color)) | [new LogDataStyle(options)](/solutions/geotoolkit/apis/classes/geotoolkit.welllog.attributes-1.logdatastyle.logdatastyle.md#new logdatastyle(options)) |
|---|
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
color | string | Color in CSS form |
datasource | string | Log data id |
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 |
renderbackground | boolean | Extra style parameter for background fill |
renderforeground | boolean | Extra style parameter for foreground fill. Normally to render patterns |
Constructors
• Protected new LogDataStyle(color?)
FillStyle.constructor
• Protected new LogDataStyle(options)
| Name | Type |
|---|---|
options | Options |
FillStyle.constructor
Accessors
• Static get Empty(): FillStyle
Empty style
FillStyle.Empty
• Static get Pick(): FillStyle
Pick style
FillStyle.Pick
Methods
▸ clone(): FillStyle
All inheritors should implement copy constructor or provide custom implementation for this method
this
▸ Protected copyConstructor(src): LogDataStyle
copy constructor
| Name | Type | Description |
|---|---|---|
src | LogDataStyle | Source to copy from |
▸ 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
▸ getInterpolationType(): InterpolationType
Returns interpolation type
▸ getLogData(): LogAbstractData
return log data
log data
▸ getLogDataId(): string
return log data id
string
▸ 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
▸ 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 |
▸ getRenderBackground(): boolean
return render background state
boolean
▸ getRenderForeground(): boolean
return render additional foreground
boolean
▸ getRgbaColor(): RgbaColor
Return RGBA color
color
▸ getShadow(): Shadow
Gets all properties pertaining to shadow
JSON with offsetX, offsetY, color and blur properties
▸ getStyleType(): string
Gets type of style this is, STYLE_TYPE_COLOR or STYLE_TYPE_PATTERN
string
styleType
▸ getTimeStamp(): number
Gets time stamp
number
timeStamp
▸ getValueAt(depth, interpolationType): number
Return value at
| Name | Type | Description |
|---|---|---|
depth | number | depth to get value at |
interpolationType | InterpolationType | interpolation type |
number
▸ Abstract getValueColor(x, depth, y?, ratio?): RgbaColor
Gets color for specified depth and values
| Name | Type | Description |
|---|---|---|
x | number | x device coordinate |
depth | number | depth |
Optional y | number | y device coordinate |
Optional ratio | number | ratio x to total width |
rgba color
▸ 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(): LogDataStyle
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?): LogDataStyle
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?): LogDataStyle
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: LogDataStyle, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): LogDataStyle
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: LogDataStyle, args: EventMap[E]) => void | to be called |
this
▸ setColor(color): LogDataStyle
Sets color
| Name | Type | Description |
|---|---|---|
color | string | RgbaColor | HsvColor | HlsColor | in CSS string form or RgbaColor object |
this
▸ setEvenOddMode(evenOddMode): LogDataStyle
Sets the even odd fill mode
| Name | Type | Description |
|---|---|---|
evenOddMode | boolean | The even odd fill mode flag. |
this
▸ setForegroundColor(color): LogDataStyle
Sets foreground color
this
▸ setInterpolationType(interpolationType): LogDataStyle
Sets interpolation type
Throws
If interpolationType is not correct
| Name | Type | Description |
|---|---|---|
interpolationType | string | interpolation type |
▸ setLogData(logData): LogDataStyle
set color provider
| Name | Type | Description |
|---|---|---|
logData | LogAbstractData | log data |
this
▸ setPattern(pattern?): LogDataStyle
Sets fill pattern.
| Name | Type | Description |
|---|---|---|
Optional pattern | Pattern | fill pattern |
this
▸ setProperties(properties?): LogDataStyle
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options | An object containing the properties to set |
this
▸ setRenderBackground(renderBackground): LogDataStyle
set render background state
| Name | Type | Description |
|---|---|---|
renderBackground | boolean | extra style parameter for background fill |
▸ setRenderForeground(renderForeground): LogDataStyle
set render foreground state
| Name | Type | Description |
|---|---|---|
renderForeground | boolean | extra style parameter for foreground fill |
▸ setShadow(shadow): LogDataStyle
Sets all properties pertaining to shadow
this
▸ setSilent(bool, force?): LogDataStyle
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
Optional force | boolean | true if parent should be invalidated immediately |
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?): LogDataStyle
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