Class GridLabel

GARS Grid Label

Hierarchy

Label
- GridLabel

Index

Constructors

Methods

getBounds getCenter getCoordinate getGridType getName setBounds setCenter setCoordinate setGridType setName

Constructors

constructor

new GridLabel(name: string, center: Point, bounds: Bounds, gridType: GridType, coordinate: GARS): GridLabel
Constructor
Parameters
- name: string
  
  name
- center: Point
  
  center point
- bounds: Bounds
  
  bounds
- gridType: GridType
  
  grid type
- coordinate: GARS
  
  GARS coordinate
Returns GridLabel
Overrides Label.constructor
- Defined in lib/grid/GridLabel.ts:35

Methods

getBounds

getBounds(): undefined | Bounds
Get the bounds

Returns
bounds

Returns undefined | Bounds
Inherited from Label.getBounds
- Defined in node_modules/@ngageoint/grid-js/dist/lib/Label.d.ts:61

getCenter

getCenter(): undefined | Point
Get the center point

Returns
center point

Returns undefined | Point
Inherited from Label.getCenter
- Defined in node_modules/@ngageoint/grid-js/dist/lib/Label.d.ts:48

getCoordinate

getCoordinate(): GARS
Get the GARS coordinate

Returns
GARS coordinate

Returns GARS
- Defined in lib/grid/GridLabel.ts:65

getGridType

getGridType(): GridType
Get the grid type

Returns
grid type

Returns GridType
- Defined in lib/grid/GridLabel.ts:46

getName

getName(): undefined | string
Get the name

Returns
name

Returns undefined | string
Inherited from Label.getName
- Defined in node_modules/@ngageoint/grid-js/dist/lib/Label.d.ts:35

setBounds

setBounds(bounds?: Bounds): void
Set the bounds
Parameters
- Optional bounds: Bounds
  
  bounds
Returns void
Inherited from Label.setBounds
- Defined in node_modules/@ngageoint/grid-js/dist/lib/Label.d.ts:68

setCenter

setCenter(center?: Point): void
Set the center point
Parameters
- Optional center: Point
  
  center point
Returns void
Inherited from Label.setCenter
- Defined in node_modules/@ngageoint/grid-js/dist/lib/Label.d.ts:55

setCoordinate

setCoordinate(coordinate: GARS): void
Set the GARS coordinate
Parameters
- coordinate: GARS
  
  GARS coordinate
Returns void
- Defined in lib/grid/GridLabel.ts:75

setGridType

setGridType(gridType: GridType): void
Set the grid type
Parameters
- gridType: GridType
  
  grid type
Returns void
- Defined in lib/grid/GridLabel.ts:56

setName

setName(name?: string): void
Set the name
Parameters
- Optional name: string
  
  name
Returns void
Inherited from Label.setName
- Defined in node_modules/@ngageoint/grid-js/dist/lib/Label.d.ts:42

Generated using TypeDoc