Class IconRow

Icon Row

Hierarchy

MediaRow
- IconRow

Index

Constructors

constructor

new IconRow(): IconRow
Constructor to create an empty row

Returns IconRow
Overrides MediaRow.constructor
- Defined in lib/extension/nga/style/iconRow.ts:18
new IconRow(table: IconTable): IconRow
Constructor to create an empty row
Parameters
- table: IconTable
  
  icon table
Returns IconRow
Overrides MediaRow.constructor
- Defined in lib/extension/nga/style/iconRow.ts:24
new IconRow(userCustomRow: UserCustomRow): IconRow
Constructor
Parameters
- userCustomRow: UserCustomRow
  
  user custom row
Returns IconRow
Overrides MediaRow.constructor
- Defined in lib/extension/nga/style/iconRow.ts:30
new IconRow(iconRow: IconRow): IconRow
Copy Constructor
Parameters
- iconRow: IconRow
  
  icon row to copy
Returns IconRow
Overrides MediaRow.constructor
- Defined in lib/extension/nga/style/iconRow.ts:36

Properties

`Protected` `Readonly` columnTypes

columnTypes: GeoPackageDataType[]

Column types of this row, based upon the data values

`Protected` `Readonly` columns

columns: UserColumns<UserCustomColumn>

User columns

`Protected` `Readonly` table

table: UserCustomTable

User table

`Protected` `Readonly` values

values: DBValue[]

Array of row values

Accessors

columnCount

get columnCount(): number
Get the column count

Returns
column count

Returns number
Inherited from MediaRow.columnCount
- Defined in lib/user/userRow.ts:171

columnNames

get columnNames(): string[]
Get the column names

Returns
column names

Returns string[]
Inherited from MediaRow.columnNames
- Defined in lib/user/userRow.ts:178

idColumn

get idColumn(): UserColumn
Gets the id column

Returns

Returns UserColumn
Inherited from MediaRow.idColumn
- Defined in lib/user/userRow.ts:164

pkColumn

get pkColumn(): UserColumn
Get the primary key column

Returns
pk column

Returns UserColumn
Inherited from MediaRow.pkColumn
- Defined in lib/user/userRow.ts:294

pkColumnIndex

get pkColumnIndex(): number
Get the primary key column Index

Returns
pk index

Returns number
Inherited from MediaRow.pkColumnIndex
- Defined in lib/user/userRow.ts:287

Methods

`Protected` columnToContentValue

columnToContentValue(contentValues: ContentValues, column: UserCustomColumn, value: any): void
Map the column to the content values
Parameters
- contentValues: ContentValues
  
  content values
- column: UserCustomColumn
  
  column
- value: any
  
  value
Returns void
Inherited from MediaRow.columnToContentValue
- Defined in lib/user/userRow.ts:469

copy

copy(): MediaRow
Copy the row

Returns
row copy

Returns MediaRow
Inherited from MediaRow.copy
- Defined in lib/extension/related/media/mediaRow.ts:182

`Protected` copyValue

copyValue(column: UserCustomColumn, value: any): any
Copy the value of the data type

Returns
copy value
Parameters
- column: UserCustomColumn
  
  table column
- value: any
  
  value
Returns any
Inherited from MediaRow.copyValue
- Defined in lib/user/userRow.ts:129

getAnchorU

getAnchorU(): number
Gets the anchor_u

Returns

Returns number
- Defined in lib/extension/nga/style/iconRow.ts:200

getAnchorUColumn

getAnchorUColumn(): UserColumn
Get the anchor_u column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/iconRow.ts:193

getAnchorUOrDefault

getAnchorUOrDefault(): number
Get the anchor u value or the default value of 0.5

Returns
anchor u value

Returns number
- Defined in lib/extension/nga/style/iconRow.ts:215

getAnchorV

getAnchorV(): number
Gets the anchor_v

Returns

Returns number
- Defined in lib/extension/nga/style/iconRow.ts:233

getAnchorVColumn

getAnchorVColumn(): UserColumn
Get the anchor_v column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/iconRow.ts:226

getAnchorVOrDefault

getAnchorVOrDefault(): number
Get the anchor v value or the default value of 1.0

Returns
anchor v value

Returns number
- Defined in lib/extension/nga/style/iconRow.ts:248

getColumn

getColumn(columnName: string): UserColumn
Get the column of the column name

Returns
column
Parameters
- columnName: string
  
  column name
Returns UserColumn
Inherited from MediaRow.getColumn
- Defined in lib/user/userRow.ts:279

getColumnIndexWithColumnName

getColumnIndexWithColumnName(columnName: string): number
Get the column index of the column name

Returns
column index
Parameters
- columnName: string
  
  column name
Returns number
Inherited from MediaRow.getColumnIndexWithColumnName
- Defined in lib/user/userRow.ts:194

getColumnNameWithIndex

getColumnNameWithIndex(index: number): string
Get the column name at the index

Returns
column name
Parameters
- index: number
  
  index
Returns string
Inherited from MediaRow.getColumnNameWithIndex
- Defined in lib/user/userRow.ts:186

getColumnWithIndex

getColumnWithIndex(index: number): UserColumn
Get the column at the index

Returns
column
Parameters
- index: number
  
  index
Returns UserColumn
Inherited from MediaRow.getColumnWithIndex
- Defined in lib/user/userRow.ts:271

getColumns

getColumns(): UserCustomColumns
Get columns

Returns

Returns UserCustomColumns
Inherited from MediaRow.getColumns
- Defined in lib/user/custom/userCustomRow.ts:56

getContentType

getContentType(): string
Get the content type

Returns
content type

Returns string
Inherited from MediaRow.getContentType
- Defined in lib/extension/related/media/mediaRow.ts:165

getContentTypeColumn

getContentTypeColumn(): UserCustomColumn
Get the content type column

Returns
content type column

Returns UserCustomColumn
Inherited from MediaRow.getContentTypeColumn
- Defined in lib/extension/related/media/mediaRow.ts:156

getContentTypeColumnIndex

getContentTypeColumnIndex(): number
Get the content type column index

Returns
content type column index

Returns number
Inherited from MediaRow.getContentTypeColumnIndex
- Defined in lib/extension/related/media/mediaRow.ts:147

getData

getData(): Buffer
Get the data

Returns
data

Returns Buffer
Inherited from MediaRow.getData
- Defined in lib/extension/related/media/mediaRow.ts:106

getDataColumn

getDataColumn(): UserCustomColumn
Get the data column

Returns
data column

Returns UserCustomColumn
Inherited from MediaRow.getDataColumn
- Defined in lib/extension/related/media/mediaRow.ts:98

getDataColumnIndex

getDataColumnIndex(): number
Get the data column index

Returns
data column index

Returns number
Inherited from MediaRow.getDataColumnIndex
- Defined in lib/extension/related/media/mediaRow.ts:89

getDataImage

getDataImage(): Promise<GeoPackageImage>
Get the data image

Returns
image

Returns Promise<GeoPackageImage>
Inherited from MediaRow.getDataImage
- Defined in lib/extension/related/media/mediaRow.ts:129

getDerivedDimensions

getDerivedDimensions(): number[]
Get the derived width and height from the values and icon data, scaled as needed

Returns
derived dimensions array with two values, width at index 0, height at index 1

Returns number[]
- Defined in lib/extension/nga/style/iconRow.ts:167

getDerivedHeight

getDerivedHeight(): number
Get the height or derived height from the icon data and scaled as needed for the width

Returns
derived height

Returns number
- Defined in lib/extension/nga/style/iconRow.ts:156

getDerivedWidth

getDerivedWidth(): number
Get the width or derived width from the icon data and scaled as needed for the height

Returns
derived width

Returns number
- Defined in lib/extension/nga/style/iconRow.ts:122

getDescription

getDescription(): string
Gets the description

Returns

Returns string
- Defined in lib/extension/nga/style/iconRow.ts:85

getDescriptionColumn

getDescriptionColumn(): UserColumn
Get the description column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/iconRow.ts:78

getHeight

getHeight(): number
Gets the height

Returns

Returns number
- Defined in lib/extension/nga/style/iconRow.ts:140

getHeightColumn

getHeightColumn(): UserColumn
Get the height column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/iconRow.ts:133

getId

getId(): number
Get the id

Returns
id

Returns number
Inherited from MediaRow.getId
- Defined in lib/extension/related/media/mediaRow.ts:80

getIdColumn

getIdColumn(): UserCustomColumn
Get the id column

Returns
id column

Returns UserCustomColumn
Inherited from MediaRow.getIdColumn
- Defined in lib/extension/related/media/mediaRow.ts:72

getIdColumnIndex

getIdColumnIndex(): number
Get the id column index

Returns
id column index

Returns number
Inherited from MediaRow.getIdColumnIndex
- Defined in lib/extension/related/media/mediaRow.ts:63

getName

getName(): string
Gets the name

Returns

Returns string
- Defined in lib/extension/nga/style/iconRow.ts:64

getNameColumn

getNameColumn(): UserColumn
Get the name column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/iconRow.ts:57

getRowColumnTypeWithColumnName

getRowColumnTypeWithColumnName(columnName: string): number
Get the row column type of the column name

Returns
row column type
Parameters
- columnName: string
  
  column name
Returns number
Inherited from MediaRow.getRowColumnTypeWithColumnName
- Defined in lib/user/userRow.ts:263

getRowColumnTypeWithIndex

getRowColumnTypeWithIndex(index: number): GeoPackageDataType
Get the row column type at the index

Returns
row column type
Parameters
- index: number
  
  index
Returns GeoPackageDataType
Inherited from MediaRow.getRowColumnTypeWithIndex
- Defined in lib/user/userRow.ts:255

getRowColumnTypes

getRowColumnTypes(): number[]
Get the row column data types

Returns
row column types

Returns number[]
Inherited from MediaRow.getRowColumnTypes
- Defined in lib/user/userRow.ts:112

getScaledDataImage

getScaledDataImage(scale: number): Promise<GeoPackageImage>
Get the scaled data image

Returns
Parameters
- scale: number
Returns Promise<GeoPackageImage>
Inherited from MediaRow.getScaledDataImage
- Defined in lib/extension/related/media/mediaRow.ts:138

getTable

getTable(): IconTable
Get the icon table

Returns IconTable
Overrides MediaRow.getTable
- Defined in lib/extension/nga/style/iconRow.ts:49

getValue

getValue(columnName: string): any
Get the value of the column name

Returns
value
Parameters
- columnName: string
  
  column name
Returns any
Inherited from MediaRow.getValue
- Defined in lib/user/userRow.ts:214

getValueWithIndex

getValueWithIndex(index: number): any
Get the value at the index

Returns
value
Parameters
- index: number
  
  index
Returns any
Inherited from MediaRow.getValueWithIndex
- Defined in lib/user/userRow.ts:202

getValues

getValues(): DBValue[]
Get the row values

Returns
values

Returns DBValue[]
Inherited from MediaRow.getValues
- Defined in lib/user/userRow.ts:103

getWidth

getWidth(): number
Gets the width

Returns

Returns number
- Defined in lib/extension/nga/style/iconRow.ts:106

getWidthColumn

getWidthColumn(): UserColumn
Get the width column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/iconRow.ts:99

hasId

hasId(): boolean
Returns boolean
Inherited from MediaRow.hasId
- Defined in lib/user/userRow.ts:391

hasIdColumn

hasIdColumn(): boolean
Returns boolean
Inherited from MediaRow.hasIdColumn
- Defined in lib/user/userRow.ts:388

isTableIcon

isTableIcon(): boolean
Is a table icon

Returns
table icon flag

Returns boolean
- Defined in lib/extension/nga/style/iconRow.ts:270

resetId

resetId(): void
Clears the id so the row can be used as part of an insert or create

Returns void
Inherited from MediaRow.resetId
- Defined in lib/user/userRow.ts:402

setAnchorU

setAnchorU(anchorU: number): void
Sets the anchor_u for the row
Parameters
- anchorU: number
Returns void
- Defined in lib/extension/nga/style/iconRow.ts:207

setAnchorV

setAnchorV(anchorV: number): void
Sets the anchor_v for the row
Parameters
- anchorV: number
Returns void
- Defined in lib/extension/nga/style/iconRow.ts:240

setContentType

setContentType(contentType: string): void
Set the content type
Parameters
- contentType: string
  
  content type
Returns void
Inherited from MediaRow.setContentType
- Defined in lib/extension/related/media/mediaRow.ts:173

setData

setData(data: Buffer): void
Set the data
Parameters
- data: Buffer
  
  data
Returns void
Inherited from MediaRow.setData
- Defined in lib/extension/related/media/mediaRow.ts:121

setDescription

setDescription(description: string): void
Sets the description for the row
Parameters
- description: string
  
  description
Returns void
- Defined in lib/extension/nga/style/iconRow.ts:92

setHeight

setHeight(height: number): void
Sets the height for the row
Parameters
- height: number
  
  height
Returns void
- Defined in lib/extension/nga/style/iconRow.ts:147

setId

setId(id: number, pkModifiable?: boolean): void
Set the id and optionally validate
Parameters
- id: number
  
  id value
- pkModifiable: boolean = ...
  
  primary key modifiable
Returns void
Inherited from MediaRow.setId
- Defined in lib/user/userRow.ts:411

setName

setName(name: string): void
Sets the name for the row
Parameters
- name: string
  
  name
Returns void
- Defined in lib/extension/nga/style/iconRow.ts:71

setTableIcon

setTableIcon(tableIcon: boolean): void
Set table icon flag
Parameters
- tableIcon: boolean
  
  table icon flag
Returns void
- Defined in lib/extension/nga/style/iconRow.ts:278

setValue

setValue(columnName: string, value: any): void
Set the value of the column name
Parameters
- columnName: string
  
  column name
- value: any
  
  value
Returns void
Inherited from MediaRow.setValue
- Defined in lib/user/userRow.ts:337

setValueNoValidationWithIndex

setValueNoValidationWithIndex(index: number, value: any): void
Set the value at the index without validation
Parameters
- index: number
  
  index
- value: any
  
  value
Returns void
Inherited from MediaRow.setValueNoValidationWithIndex
- Defined in lib/user/userRow.ts:329

setValueWithIndex

setValueWithIndex(index: number, value: any): void
Set the value at the index
Parameters
- index: number
  
  index
- value: any
  
  value
Returns void
Inherited from MediaRow.setValueWithIndex
- Defined in lib/user/userRow.ts:302

setWidth

setWidth(width: number): void
Sets the width for the row
Parameters
- width: number
  
  width
Returns void
- Defined in lib/extension/nga/style/iconRow.ts:113

toContentValues

toContentValues(includeNulls?: boolean): ContentValues
Convert the row to content values

Returns
content values
Parameters
- includeNulls: boolean = true
  
  include null values (default is true)
Returns ContentValues
Inherited from MediaRow.toContentValues
- Defined in lib/user/userRow.ts:440

toDatabaseValue

toDatabaseValue(columnName: string): DBValue
Get the value which will be persisted to the database based on the column
Parameters
- columnName: string
  
  name of the column
Returns DBValue
Inherited from MediaRow.toDatabaseValue
- Defined in lib/user/userRow.ts:242

toObjectValue

toObjectValue(index: number, value: DBValue): any
Get the value from the database as an object based on the column
Parameters
- index: number
  
  column index
- value: DBValue
  
  value from the database
Returns any
Inherited from MediaRow.toObjectValue
- Defined in lib/user/userRow.ts:230

validateAnchor

validateAnchor(anchor: number): boolean
Validate the anchor value
Parameters
- anchor: number
  
  anchor
Returns boolean
- Defined in lib/extension/nga/style/iconRow.ts:259

`Protected` validateValue

validateValue(column: UserCustomColumn, value: any, valueTypes: string[]): void
Validate the value and its actual value types against the column data type class
Parameters
- column: UserCustomColumn
  
  column
- value: any
  
  value
- valueTypes: string[]
  
  value type
Returns void
Inherited from MediaRow.validateValue
- Defined in lib/user/userRow.ts:519

Class IconRow

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns IconRow

Parameters

table: IconTable

Returns IconRow

Parameters

userCustomRow: UserCustomRow

Returns IconRow

Parameters

iconRow: IconRow

Returns IconRow

Properties

Protected Readonly columnTypes

Protected Readonly columns

Protected Readonly table

Protected Readonly values

Accessors

columnCount

Returns

Returns number

columnNames

Returns

Returns string[]

idColumn

Returns

Returns UserColumn

pkColumn

Returns

Returns UserColumn

pkColumnIndex

Returns

Returns number

Methods

Protected columnToContentValue

Parameters

contentValues: ContentValues

column: UserCustomColumn

value: any

Returns void

copy

Returns

Returns MediaRow

Protected copyValue

Returns

Parameters

column: UserCustomColumn

value: any

Returns any

getAnchorU

Returns

Returns number

getAnchorUColumn

Returns

Returns UserColumn

getAnchorUOrDefault

Returns

Returns number

getAnchorV

Returns

Returns number

getAnchorVColumn

Returns

Returns UserColumn

getAnchorVOrDefault

Returns

Returns number

getColumn

Returns

Parameters

columnName: string

Returns UserColumn

getColumnIndexWithColumnName

`Protected` `Readonly` columnTypes

`Protected` `Readonly` columns

`Protected` `Readonly` table

`Protected` `Readonly` values

`Protected` columnToContentValue

`Protected` copyValue