API / geotoolkit / controls / shapes / TernaryGrid / TernaryGrid
shapes.TernaryGrid.TernaryGrid
Type Aliases
Type Aliases
Ƭ ConvertValues: Object
values in ternary coordinates
| Name | Type | Description |
|---|---|---|
left? | number | value of the left corner coordinate |
right? | number | value of the right corner coordinate |
top? | number | value of the top corner coordinate |
Ƭ Options: Options & OptionsBase & { options?: OptionsBase }
Ƭ OptionsBase: Object
| Name | Type | Description |
|---|---|---|
border? | { linestyle?: Type ; visible?: boolean } | border properties |
border.linestyle? | Type | line style of border |
border.visible? | boolean | visibility of border |
center? | Point | { x: number ; y: number } | a center of the ternary grid |
gridlines? | { left?: { linestyle?: Type ; step?: number ; textstyle?: Type ; visible?: boolean ; visiblelabels?: boolean } ; right?: { linestyle?: Type ; step?: number ; textstyle?: Type ; visible?: boolean ; visiblelabels?: boolean } ; top?: { linestyle?: Type ; step?: number ; textstyle?: Type ; visible?: boolean ; visiblelabels?: boolean } } | gridlines properties |
gridlines.left? | { linestyle?: Type ; step?: number ; textstyle?: Type ; visible?: boolean ; visiblelabels?: boolean } | define options of left corner value gridlines |
gridlines.left.linestyle? | Type | line style of left corner value gridlines |
gridlines.left.step? | number | step of left corner value gridlines |
gridlines.left.textstyle? | Type | value labels style for left corner value |
gridlines.left.visible? | boolean | visibility of left corner value grid |
gridlines.left.visiblelabels? | boolean | define visibility of value labels next to left corner value grid lines |
gridlines.right? | { linestyle?: Type ; step?: number ; textstyle?: Type ; visible?: boolean ; visiblelabels?: boolean } | define options of right corner value gridlines |
gridlines.right.linestyle? | Type | line style of right corner value gridlines |
gridlines.right.step? | number | step of right corner value gridlines |
gridlines.right.textstyle? | Type | value labels style for right corner value |
gridlines.right.visible? | boolean | visibility of right corner value grid |
gridlines.right.visiblelabels? | boolean | define visibility of value labels next to right corner value grid lines |
gridlines.top? | { linestyle?: Type ; step?: number ; textstyle?: Type ; visible?: boolean ; visiblelabels?: boolean } | define options of top corner value gridlines |
gridlines.top.linestyle? | Type | line style of top corner value gridlines |
gridlines.top.step? | number | step of top corner value gridlines |
gridlines.top.textstyle? | Type | value labels style for top corner value |
gridlines.top.visible? | boolean | visibility of top corner value grid |
gridlines.top.visiblelabels? | boolean | define visibility of value labels next to top corner value grid lines |
labels? | { left?: { text?: string ; textstyle?: Type } ; right?: { text?: string ; textstyle?: Type } ; top?: { text?: string ; textstyle?: Type } } | corner annotations properties |
labels.left? | { text?: string ; textstyle?: Type } | left corner annotation properties |
labels.left.text? | string | text to be displayed at left corner |
labels.left.textstyle? | Type | style for left corner annotations |
labels.right? | { text?: string ; textstyle?: Type } | right corner annotation properties |
labels.right.text? | string | text to be displayed at right corner |
labels.right.textstyle? | Type | style for right corner annotations |
labels.top? | { text?: string ; textstyle?: Type } | top corner annotation properties |
labels.top.text? | string | text to be displayed at top corner |
labels.top.textstyle? | Type | style for top corner annotations |
limits? | { left?: { max?: number ; min?: number } ; right?: { max?: number ; min?: number } ; top?: { max?: number ; min?: number } } | value limits for axes (by default from 0 to 100) |
limits.left? | { max?: number ; min?: number } | value limits for left corner value (by default from 0 to 100) |
limits.left.max? | number | maximum value for left corner value |
limits.left.min? | number | minimum value for left corner value |
limits.right? | { max?: number ; min?: number } | value limits for right corner value (by default from 0 to 100) |
limits.right.max? | number | maximum value for right corner value |
limits.right.min? | number | minimum value for right corner value |
limits.top? | { max?: number ; min?: number } | value limits for top corner value (by default from 0 to 100) |
limits.top.max? | number | maximum value for top corner value |
limits.top.min? | number | minimum value for top corner value |
size? | number | size of ternary chart |
textstyle? | Type | - |
Ƭ OptionsOut: OptionsOut & Required<OptionsBase> & { options: OptionsBase }
object containing grid properties