API / geotoolkit3d / scene / grid / legend / GridLegend / GridLegend
legend.GridLegend.GridLegend
Type Aliases
Type Aliases
Ƭ Options: Object
options object
| Name | Type | Description |
|---|---|---|
centerbeforehiding? | boolean | if true and hideiftoolarge enabled, will try to shift the legend text to fit inside the panel if possible. |
hideiftoolarge? | boolean | if true, hide the legend text when it doesnt fit inside it's panel. |
planes? | { back?: PlaneOptions ; front?: PlaneOptions ; left?: PlaneOptions ; right?: PlaneOptions } | planes options object |
planes.back? | PlaneOptions | back plane options object |
planes.front? | PlaneOptions | front plane options object |
planes.left? | PlaneOptions | left plane options object |
planes.right? | PlaneOptions | right plane options object |
Ƭ PlaneOptions: Object
| Name | Type | Description |
|---|---|---|
centerbeforehiding? | boolean | - |
enable? | boolean | if the plane text is visible or not. |
hideiftoolarge? | boolean | - |
horizontalanchor? | HorizontalAnchorPosition | The horizontal anchor position for the legend (default is Center) |
nearside? | boolean | if true, show the text on the near face of the grid cube, if false, show on the far face of the grid cube. |
outline? | OutlineOptions | outline options |
sizeindevice? | boolean | if true, the on-screen size of the text will always be the same, if false, it will depend on zoom level. |
style? | Type | the style of the legend text (Font, size, color...) |
text? | string | the plane text to display, supports newlines/carriage returns. |
textoffset? | Vector2 | local X,Y offset for text position, (0,0 is bottom left, 1,1 is top right, relative to the plane) |
textscale? | number | the text scale. To use with sizeindevice=false. If text is blury, it is recommended to increase testStyle font size before increasing textscale. |
verticalanchor? | VerticalAnchorPosition | The vertical anchor position for the legend (default is Center) |