Class StyleRow

Style Row

Hierarchy

AttributesRow
- StyleRow

Index

Constructors

constructor

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

Returns StyleRow
Overrides AttributesRow.constructor
- Defined in lib/extension/nga/style/styleRow.ts:19
new StyleRow(table: StyleTable): StyleRow
Constructor to create an empty row
Parameters
- table: StyleTable
  
  style table
Returns StyleRow
Overrides AttributesRow.constructor
- Defined in lib/extension/nga/style/styleRow.ts:25
new StyleRow(attributesRow: AttributesRow): StyleRow
Constructor
Parameters
- attributesRow: AttributesRow
  
  attributes row
Returns StyleRow
Overrides AttributesRow.constructor
- Defined in lib/extension/nga/style/styleRow.ts:31
new StyleRow(styleRow: StyleRow): StyleRow
Copy Constructor
Parameters
- styleRow: StyleRow
  
  style row to copy
Returns StyleRow
Overrides AttributesRow.constructor
- Defined in lib/extension/nga/style/styleRow.ts:37

Properties

`Protected` `Readonly` columnTypes

columnTypes: GeoPackageDataType[]

Column types of this row, based upon the data values

`Protected` `Readonly` columns

columns: UserColumns<AttributesColumn>

User columns

`Protected` `Readonly` table

table: AttributesTable

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 AttributesRow.columnCount
- Defined in lib/user/userRow.ts:171

columnNames

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

Returns
column names

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

idColumn

get idColumn(): UserColumn
Gets the id column

Returns

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

pkColumn

get pkColumn(): UserColumn
Get the primary key column

Returns
pk column

Returns UserColumn
Inherited from AttributesRow.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 AttributesRow.pkColumnIndex
- Defined in lib/user/userRow.ts:287

Methods

_hasColor

_hasColor(hexColor: string, opacity: number): boolean
Determine if a color exists from the hex color and opacity

Returns
true if has a color
Parameters
- hexColor: string
  
  hex color
- opacity: number
  
  opacity
Returns boolean
- Defined in lib/extension/nga/style/styleRow.ts:340

`Protected` columnToContentValue

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

copy

copy(): AttributesRow
Copy the row

Returns
row copy

Returns AttributesRow
Inherited from AttributesRow.copy
- Defined in lib/attributes/attributesRow.ts:55

`Protected` copyValue

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

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

createColor

createColor(hexColor: string, opacity: number): string
Create a color from the hex color and opacity

Returns
rgba color
Parameters
- hexColor: string
  
  hex color
- opacity: number
  
  opacity
Returns string
- Defined in lib/extension/nga/style/styleRow.ts:320

getColor

getColor(): string
Get the style color

Returns
color

Returns string
- Defined in lib/extension/nga/style/styleRow.ts:107

getColorColumn

getColorColumn(): UserColumn
Get the color column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/styleRow.ts:100

getColumn

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

Returns
column
Parameters
- columnName: string
  
  column name
Returns UserColumn
Inherited from AttributesRow.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 AttributesRow.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 AttributesRow.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 AttributesRow.getColumnWithIndex
- Defined in lib/user/userRow.ts:271

getColumns

getColumns(): AttributesColumns
Gets the columns

Returns AttributesColumns
Inherited from AttributesRow.getColumns
- Defined in lib/attributes/attributesRow.ts:47

getDescription

getDescription(): string
Gets the description

Returns

Returns string
- Defined in lib/extension/nga/style/styleRow.ts:86

getDescriptionColumn

getDescriptionColumn(): UserColumn
Get the description column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/styleRow.ts:79

getFillColor

getFillColor(): string
Get the style fill color

Returns
color

Returns string
- Defined in lib/extension/nga/style/styleRow.ts:220

getFillColorColumn

getFillColorColumn(): UserColumn
Get the fill color column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/styleRow.ts:213

getFillHexColor

getFillHexColor(): string
Get the fill color

Returns
color

Returns string
- Defined in lib/extension/nga/style/styleRow.ts:234

getFillOpacity

getFillOpacity(): number
Gets the fill opacity

Returns

Returns number
- Defined in lib/extension/nga/style/styleRow.ts:265

getFillOpacityColumn

getFillOpacityColumn(): UserColumn
Get the fill opacity column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/styleRow.ts:258

getFillOpacityOrDefault

getFillOpacityOrDefault(): number
Get the fill opacity or default value

Returns
fill opacity

Returns number
- Defined in lib/extension/nga/style/styleRow.ts:280

getHexColor

getHexColor(): string
Get the color

Returns
color

Returns string
- Defined in lib/extension/nga/style/styleRow.ts:121

getId

getId(): number
Get the id value, which is the value of the primary key

Returns
id

Returns number
Inherited from AttributesRow.getId
- Defined in lib/user/userRow.ts:347

getName

getName(): string
Gets the name

Returns

Returns string
- Defined in lib/extension/nga/style/styleRow.ts:65

getNameColumn

getNameColumn(): UserColumn
Get the name column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/styleRow.ts:58

getOpacity

getOpacity(): number
Gets the opacity

Returns

Returns number
- Defined in lib/extension/nga/style/styleRow.ts:152

getOpacityColumn

getOpacityColumn(): UserColumn
Get the opacity column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/styleRow.ts:145

getOpacityOrDefault

getOpacityOrDefault(): number
Get the opacity or default value

Returns
opacity

Returns number
- Defined in lib/extension/nga/style/styleRow.ts:159

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 AttributesRow.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 AttributesRow.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 AttributesRow.getRowColumnTypes
- Defined in lib/user/userRow.ts:112

getTable

getTable(): StyleTable
Return the table

Returns StyleTable
Overrides AttributesRow.getTable
- Defined in lib/extension/nga/style/styleRow.ts:50

getValue

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

Returns
value
Parameters
- columnName: string
  
  column name
Returns any
Inherited from AttributesRow.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 AttributesRow.getValueWithIndex
- Defined in lib/user/userRow.ts:202

getValues

getValues(): DBValue[]
Get the row values

Returns
values

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

getWidth

getWidth(): number
Gets the width

Returns

Returns number
- Defined in lib/extension/nga/style/styleRow.ts:185

getWidthColumn

getWidthColumn(): UserColumn
Get the width column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/styleRow.ts:178

getWidthOrDefault

getWidthOrDefault(): number
Get the width value or default width

Returns
width

Returns number
- Defined in lib/extension/nga/style/styleRow.ts:202

hasColor

hasColor(): boolean
Check if the style has a color

Returns
true if has a color

Returns boolean
- Defined in lib/extension/nga/style/styleRow.ts:114

hasFillColor

hasFillColor(): boolean
Check if the style has a fill color

Returns
true if has a color

Returns boolean
- Defined in lib/extension/nga/style/styleRow.ts:227

hasId

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

hasIdColumn

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

isTableStyle

isTableStyle(): boolean
Is a table style

Returns
table style flag

Returns boolean
- Defined in lib/extension/nga/style/styleRow.ts:348

resetId

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

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

setColor

setColor(color: string, opacity: number): void
Set the color
Parameters
- color: string
  
  color
- opacity: number
  
  opacity
Returns void
- Defined in lib/extension/nga/style/styleRow.ts:129

setDescription

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

setFillColor

setFillColor(color: string, opacity: number): void
Set the fill color
Parameters
- color: string
  
  color
- opacity: number
  
  opacity
Returns void
- Defined in lib/extension/nga/style/styleRow.ts:242

setFillHexColor

setFillHexColor(color: string): void
Sets the fill color for the row
Parameters
- color: string
  
  color
Returns void
- Defined in lib/extension/nga/style/styleRow.ts:250

setFillOpacity

setFillOpacity(fillOpacity: number): void
Sets the fill opacity for the row
Parameters
- fillOpacity: number
  
  fillOpacity
Returns void
- Defined in lib/extension/nga/style/styleRow.ts:272

setHexColor

setHexColor(color: string): void
Sets the color for the row
Parameters
- color: string
  
  color
Returns void
- Defined in lib/extension/nga/style/styleRow.ts:137

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 AttributesRow.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/styleRow.ts:72

setOpacity

setOpacity(opacity: number): void
Sets the opacity for the row
Parameters
- opacity: number
  
  opacity
Returns void
- Defined in lib/extension/nga/style/styleRow.ts:170

setTableStyle

setTableStyle(tableStyle: boolean): void
Set table style flag
Parameters
- tableStyle: boolean
  
  table style flag
Returns void
- Defined in lib/extension/nga/style/styleRow.ts:356

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 AttributesRow.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 AttributesRow.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 AttributesRow.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/styleRow.ts:192

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 AttributesRow.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 AttributesRow.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 AttributesRow.toObjectValue
- Defined in lib/user/userRow.ts:230

validateColor

validateColor(color: string): string
Validate and adjust the color value
Parameters
- color: string
  
  color
Returns string
- Defined in lib/extension/nga/style/styleRow.ts:291

validateOpacity

validateOpacity(opacity: number): boolean
Validate the opacity value
Parameters
- opacity: number
  
  opacity
Returns boolean
- Defined in lib/extension/nga/style/styleRow.ts:308

`Protected` validateValue

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

Class StyleRow

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns StyleRow

Parameters

table: StyleTable

Returns StyleRow

Parameters

attributesRow: AttributesRow

Returns StyleRow

Parameters

styleRow: StyleRow

Returns StyleRow

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

_hasColor

Returns

Parameters

hexColor: string

opacity: number

Returns boolean

Protected columnToContentValue

Parameters

contentValues: ContentValues

column: AttributesColumn

value: any

Returns void

copy

Returns

Returns AttributesRow

Protected copyValue

Returns

Parameters

column: AttributesColumn

value: any

Returns any

createColor

Returns

Parameters

hexColor: string

opacity: number

Returns string

getColor

Returns

Returns string

getColorColumn

Returns

Returns UserColumn

getColumn

Returns

Parameters

columnName: string

Returns UserColumn

getColumnIndexWithColumnName

`Protected` `Readonly` columnTypes

`Protected` `Readonly` columns

`Protected` `Readonly` table

`Protected` `Readonly` values

`Protected` columnToContentValue

`Protected` copyValue