Class: LineStyle

• [new LineStyle(color, width, pattern)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.attributes.linestyle.linestyle.md#new linestyle(color, width, pattern))

• new LineStyle(color?, width?, pattern?)

Create LineStyle

Example

import {LineStyle} from '@int/geotoolkit/attributes/LineStyle';

const blackLineStyle = new LinesStyle();
const redLineStyle = new LineStyle('red', 1).setPixelSnapode(true);
const greenLineStyle = new LineStyle({
'color': 'green',
'width': 1,
'pixelsnapmode: true
});
const blueLineStyle = new LineStyle('1px solid blue');

ColoredStyle.constructor

• Static get Empty(): LineStyle

Empty style

LineStyle

• Static get Pick(): LineStyle

Pick style

LineStyle

▸ clone(): LineStyle

All inheritors should implement copy constructor or provide custom implementation for this method

LineStyle

this

ColoredStyle.clone

▸ Protected copyConstructor(src, deepCopy?): LineStyle

copy constructor

LineStyle

this

ColoredStyle.copyConstructor

▸ dispose(): void

Dispose.

void

ColoredStyle.dispose

▸ equalsTo(other): boolean

Returns true if linestyles are identical

boolean

▸ getCapStyle(): string

Get current line cap style

string

capStyle can be 'butt', 'square', or 'round'

▸ getClassName(): string

string

ColoredStyle.getClassName

▸ getColor(): string

Returns color

string

color in CSS form

ColoredStyle.getColor

▸ getFillStyle(): FillStyle

Returns fill style

FillStyle

fill style

▸ getJoinStyle(): string

Get current join style

string

join style

▸ getLineDashOffset(): number

Get line dash offset

number

Line dash offset

▸ getPattern(): number[] | Patterns

Return line pattern

number[] | Patterns

pattern

▸ getPixelSnapMode(): PixelSnapMode

return Pixel Snap Mode

PixelSnapMode

▸ getProperties(context?): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

ColoredStyle.getProperties

▸ getRgbaColor(): RgbaColor

Return RGBA color

RgbaColor

color

ColoredStyle.getRgbaColor

▸ getShadow(): Shadow

Gets all properties pertaining to shadow

Shadow

JSON with offsetX, offsetY, color and blur properties

ColoredStyle.getShadow

▸ getTimeStamp(): number

Gets time stamp

number

timeStamp

ColoredStyle.getTimeStamp

▸ getUnit(): AbstractUnit

Returns unit of the measure for the width

AbstractUnit

▸ getWidth(): number

Return line width

number

line width

▸ hasEventListener(type, callback?): boolean

Check if a list of event listeners for this type contains this listener

boolean

ColoredStyle.hasEventListener

▸ invalidate(): LineStyle

notify the node that the style is invalidated

LineStyle

this

ColoredStyle.invalidate

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

ColoredStyle.isDisposed

▸ isScalable(): boolean

Returns true if width depends on transformation

boolean

true if width depends on transformation

▸ isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

boolean

ColoredStyle.isSilent

▸ notify<E&gt;(type, source, args?): LineStyle

Notify listeners

LineStyle

this

ColoredStyle.notify

▸ off<E&gt;(type?, callback?): LineStyle

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.

LineStyle

this

ColoredStyle.off

▸ on<E&gt;(type, callback): LineStyle

Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> 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. </p>

LineStyle

this

ColoredStyle.on

▸ setCapStyle(capStyle): LineStyle

Line cap style, passes through to canvas directly

LineStyle

this

▸ setColor(color): LineStyle

Sets color

LineStyle

this

ColoredStyle.setColor

▸ setFillStyle(fill): LineStyle

Sets fill style to fill line content. if fill is set line color is ignored

LineStyle

this

▸ setJoinStyle(lineJoin): LineStyle

Line join style, passes through to the underlying html5 canvas renderer.

LineStyle

this

▸ setLineDashOffset(lineDashOffset): LineStyle

Set line dash offset of dashed line

LineStyle

this

▸ setPattern(pattern): LineStyle

Sets line pattern

LineStyle

this

▸ setPixelSnapMode(pixelSnapMode?): LineStyle

Set Pixel Snap Mode

LineStyle

this

▸ setProperties(properties?): LineStyle

Sets all the properties pertaining to this object

LineStyle

this

ColoredStyle.setProperties

▸ setScalable(scalable): LineStyle

Set true if width should depend on transformation

LineStyle

this

▸ setShadow(shadow): LineStyle

Sets all properties pertaining to shadow

LineStyle

this

ColoredStyle.setShadow

▸ setSilent(bool, force?): LineStyle

Set silent mode

LineStyle

this

ColoredStyle.setSilent

▸ setUnit(unit): LineStyle

Sets unit of the measure for the width

LineStyle

this

▸ setWidth(width): LineStyle

Sets line width

LineStyle

this

▸ toGrayScale(clone?): LineStyle

Clone the instance in grayscale style, or convert itself if [clone] is false.

LineStyle

ColoredStyle.toGrayScale

▸ updateTimeStamp(silent?): LineStyle

Update time stamp to indicate that style has been changed.

LineStyle

this

ColoredStyle.updateTimeStamp

▸ Static fromObject(object?): LineStyle

Create or get line style from object

LineStyle

line style

▸ Static getClassName(): string

string

ColoredStyle.getClassName

▸ Static isStyleNotificationEnabled(): boolean

Return status of the global notification for all styles.

boolean

ColoredStyle.isStyleNotificationEnabled

▸ Static mergeFromObject(node, lineStyle, object, merge?, invalidateMethod?): LineStyle

Merge css linestyle object with existing instance

Example

import {Shape} from '@int/geotoolkit/scene/shapes/Shape';
import {LineStyle} from '@int/geotoolkit/attributes/LineStyle';

class CustomSymbol extends Shape {
...
public setLineStyle (lineStyle: LineStyle.Type, merge?: boolean): this {
lineStyle = LineStyle.mergeFromObject(this, this.getLineStyle(), lineStyle, merge);
return super.setLineStyle(lineStyle);
}
...
}

const symbol = new CustomSymbol(new Rect(50, 50, 150, 150))
.setLineStyle({
'color': KnownColors.Orange
})
.setLineStyle({
'width': 13
}, true);

LineStyle

lineStyle