Last updated

API / geotoolkit / controls / shapes / PolarGrid / PolarGrid

Namespace: PolarGrid

shapes.PolarGrid.PolarGrid

Table of contents

Type Aliases

Contents

Type Aliases

GridLines

Ƭ GridLines: Object

Type declaration

NameTypeDescription
angles?{ labeloffset?: number ; labels?: { text?: (string | number)[] ; values?: number[] } ; labelsalongcircumference?: boolean ; linestyle?: Type ; textstyle?: Type ; visible?: boolean ; visiblelabels?: boolean }define options of angles gridlines
angles.labeloffset?numberradius offset for labels
angles.labels?{ text?: (string | number)[] ; values?: number[] }define optional labels instead of standard
angles.labels.text?(string | number)[]define optional array of text labels
angles.labels.values?number[]define optional array of angles
angles.labelsalongcircumference?booleanlabels drawn along outer circumference
angles.linestyle?Typeline style
angles.textstyle?Typelabels style
angles.visible?booleanvisibility of angles grid
angles.visiblelabels?booleanvisibility of angles labels
radius?{ highlighted?: Type ; linestyle?: Type ; step?: number ; values?: number[] ; visible?: boolean }define options of radius gridlines
radius.highlighted?Typedefine a color to highlight grid
radius.linestyle?Typeline style
radius.step?numberstep by radius in model coordinates
radius.values?number[]optional positions of lines. In this case step ignored. values are in raduses
radius.visible?booleanvisibility of radius grid

Options

Ƭ Options: Options & OptionsBase & { options?: OptionsBase }


OptionsBase

Ƭ OptionsBase: Object

object containing grid options

Type declaration

NameTypeDescription
angle?numberan increment angle of the grid
center?Point | { x: number ; y: number }a center of the polar chart
gridlines?GridLinesgridlines properties
linestyle?Typeline style to specify style for outer circle
modelradius?numberradius of the polar chart in the model coordinates
outerradius?numbera radius of the polar chart
startangle?numbera start angle to be used for 0 angle (by default it is E direction)

OptionsBaseOut

Ƭ OptionsBaseOut: Merge<OptionsBase, { center: Point }>


OptionsOut

Ƭ OptionsOut: OptionsOut & OptionsBaseOut & { options: OptionsBaseOut }

object containing grid properties


Sector

Ƭ Sector: Object

Grid sector info

Type declaration

NameType
colorstring
endnumber
length?number
startnumber