Last updated

API / geotoolkit3d / scene / grid / PolarGrid / PolarGrid

Namespace: PolarGrid

grid.PolarGrid.PolarGrid

Table of contents

Type Aliases

Contents

Type Aliases

AdditionalAxisMarkers

Ƭ AdditionalAxisMarkers: Record<number, { linestyle?: Type ; text?: string ; textstyle?: Type }>

Custom axis tick options, key number is angle in degree from 0 to 360


AdditionalGridMarkers

Ƭ AdditionalGridMarkers: Record<number, { linestyle?: Type }>

Custom grid tick options, key number is radius in model space, it should be in interval [modelCenter, modelCenter + modelSize] to be visible


FormatterFunction

Ƭ FormatterFunction: (el: number) => string

Type declaration

▸ (el): string

User-defined formatter function which provide a number as input, and expect a string as a return.

Parameters
Name Type
elnumber
Returns

string


Options

Ƭ Options: Omit<Options, "isselectable"> & { angletickgenerator?: TickGenerator ; axis?: { additional?: AdditionalAxisMarkers ; formatter?: FormatterFunction ; linestyle?: Type ; outline?: OutlineOptions ; textstyle?: Type } ; axiscount?: number ; count?: number ; grid?: { additional?: AdditionalGridMarkers ; linestyle?: Type } ; modelcenter?: number ; modelsize?: number ; radialtickgenerator?: TickGenerator }

The Polar Grid options.


OptionsOut

Ƭ OptionsOut: Required<Options> & Options