API / geotoolkit / report / elements / styles / BorderStyle / BorderStyle
styles.BorderStyle.BorderStyle
Parent class for all styles
↳
BorderStyle
Constructors
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
color | string | Color in CSS form |
fill | string | Optional fill style to be used to fill lines generated with this style |
fill | FillStyle | Optional fill style to be used to fill lines generated with this style |
fill-color | string | Color in CSS form |
fill-evenoddmode | boolean | Even-odd fill mode |
fill-fillpattern | Pattern | Pattern |
fill-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 |
fill-fillpattern-patternname | string | Name of this pattern for indexing |
fill-fillpattern-scalable | boolean | Flag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported) |
fill-foreground | string | Foreground color |
fill-pattern | Pattern | Pattern |
linecap | CapStyle | The line cap style |
linedashoffset | number | Line dash offset of dashed line |
linejoin | JoinStyle | The line join style |
pixelsnapmode | boolean | Pixel Snap Mode, default( |
scalable | boolean | True if width should depend on transformation |
unit | string | Optional unit for the width |
width | number | string | The line thickness |
Constructors
• new BorderStyle(style?)
| Name | Type |
|---|---|
Optional style | string | { all?: Type ; bottom?: Type ; collapse?: boolean ; left?: Type ; radius?: string ; right?: Type ; shorthand?: string ; spacing?: string ; top?: Type } |
ElementStyle.constructor
Methods
▸ clone(): Style
All inheritors should implement copy constructor or provide custom implementation for this method
this
▸ Protected copyConstructor(src, deepCopy?): BorderStyle
copy constructor
| Name | Type | Description |
|---|---|---|
src | Style | Source to copy from |
Optional deepCopy | boolean | deep copy |
this
▸ Protected createStyle(styleName, styleValue): string | Record<string, any> | ElementStyle
| Name | Type | Description |
|---|---|---|
styleName | string | styleName |
styleValue | string | styleValue |
string | Record<string, any> | ElementStyle
▸ dispose(): void
Dispose.
void
▸ drawBorder(context, bounds): void
Render border
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context |
bounds | Rect | bounds |
void
▸ getClassName(): string
string
▸ getProperties(): OptionsOut | EmptyRecord
Gets all the properties pertaining to this object
▸ getRadius(unit?): SpaceStyle<string | number> | RadiusInPixels
Return border radiuses
| Name | Type | Description |
|---|---|---|
Optional unit | string | AbstractUnit | unit to convert |
SpaceStyle<string | number> | RadiusInPixels
▸ getStyle(styleName?): string | number | Record<string, any> | ElementStyle
| Name | Type | Description |
|---|---|---|
Optional styleName | string | styleName 'border-left'|'fill-pattern-position'|'float'|..... |
string | number | Record<string, any> | ElementStyle
style
▸ getTimeStamp(): number
Gets time stamp
number
timeStamp
▸ 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(): BorderStyle
notify the node that the style is invalidated
this
▸ isCollapsed(): boolean
Return border collapse state
boolean
▸ 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?): BorderStyle
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?): BorderStyle
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 |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: BorderStyle, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): BorderStyle
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: BorderStyle, args: EventMap[E]) => void | to be called |
this
▸ parse(styleValue): BorderStyle
Parse margin value
| Name | Type | Description |
|---|---|---|
styleValue | string | styleValue |
this
▸ Protected parseStyle(styleName, styleValue): string | Record<string, any> | ElementStyle
| Name | Type | Description |
|---|---|---|
styleName | string | styleName |
styleValue | string | ElementStyle | styleValue |
string | Record<string, any> | ElementStyle
▸ removeStyle(styleName): BorderStyle
Remove style attribute
| Name | Type | Description |
|---|---|---|
styleName | string | string[] | style name |
▸ setParent(parent): BorderStyle
| Name | Type |
|---|---|
parent | ElementStyle |
▸ setProperties(properties?): BorderStyle
Set border style properties
| Name | Type | Description |
|---|---|---|
Optional properties | Options | An object containing the properties to set |
▸ setSilent(bool, force?): BorderStyle
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
Optional force | boolean | true if parent should be invalidated immediately |
this
▸ setStyle(style, value?): BorderStyle
| Name | Type |
|---|---|
style | any |
Optional value | any |
▸ toString(styleName?): string
Convert Style attribute to string
| Name | Type | Description |
|---|---|---|
Optional styleName | string | style name |
string
▸ updateTimeStamp(silent?): BorderStyle
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