Class GobanTheme

Constructors

constructor

new GobanTheme(parent?): GobanTheme
Parameters
- Optional parent: GobanTheme
Returns GobanTheme
- Defined in Goban/themes/GobanTheme.ts:78

Properties

name

name: string

`Protected` `Optional` parent

parent?: GobanTheme

styles

styles: {
[style_name: string]: string;
} = {}

Type declaration

[style_name: string]: string

Accessors

theme_name

get theme_name(): string
Returns string
- Defined in Goban/themes/GobanTheme.ts:83

Methods

`Private` createGradientStop

createGradientStop(config): SVGStopElement
Creates a single SVG stop element
Parameters
- config: GradientStopConfig
Returns SVGStopElement
- Defined in Goban/themes/GobanTheme.ts:295

`Private` createRadialGradient

createRadialGradient(id, config): SVGRadialGradientElement
Creates a radial gradient SVG element with the given configuration
Parameters
- id: string
- config: ShadowConfig
Returns SVGRadialGradientElement
- Defined in Goban/themes/GobanTheme.ts:270

def_uid

def_uid(base): string
Parameters
- base: string
Returns string
- Defined in Goban/themes/GobanTheme.ts:633

getBackgroundCSS

getBackgroundCSS(): GobanThemeBackgroundCSS
Returns GobanThemeBackgroundCSS
- Defined in Goban/themes/GobanTheme.ts:494

getBlackStoneColor

getBlackStoneColor(): string
Returns string
- Defined in Goban/themes/GobanTheme.ts:479

getBlackTextColor

getBlackTextColor(_color?): string
Parameters
- Optional _color: string
Returns string
- Defined in Goban/themes/GobanTheme.ts:489

getBlankTextColor

getBlankTextColor(): string
Returns string
- Defined in Goban/themes/GobanTheme.ts:534

`Protected` getCDNReleaseBase

getCDNReleaseBase(): string
Returns string
- Defined in Goban/themes/GobanTheme.ts:640

getFadedLineColor

getFadedLineColor(): string
Returns string
- Defined in Goban/themes/GobanTheme.ts:518

getFadedStarColor

getFadedStarColor(): string
Returns string
- Defined in Goban/themes/GobanTheme.ts:529

getLabelTextColor

getLabelTextColor(): string
Returns the color that should be used for labels

Returns string
- Defined in Goban/themes/GobanTheme.ts:539

getLineColor

getLineColor(): string
Returns string
- Defined in Goban/themes/GobanTheme.ts:513

getPreferredShadowTheme

getPreferredShadowTheme(): ShadowTheme
Returns ShadowTheme
- Defined in Goban/themes/GobanTheme.ts:469

getReactStyles

getReactStyles(): GobanThemeBackgroundReactStyles
Returns GobanThemeBackgroundReactStyles
- Defined in Goban/themes/GobanTheme.ts:502

getShadowColor

getShadowColor(_color?): string
Parameters
- Optional _color: string
Returns string
- Defined in Goban/themes/GobanTheme.ts:544

`Private` getShadowConfig

getShadowConfig(shadow_theme, color, shadow_color, custom_config?): ShadowConfig
Gets the shadow configuration for a given theme
Parameters
- shadow_theme: ShadowTheme
- color: string
- shadow_color: string
- Optional custom_config: CustomShadowConfig
Returns ShadowConfig
- Defined in Goban/themes/GobanTheme.ts:193

getStarColor

getStarColor(): string
Returns string
- Defined in Goban/themes/GobanTheme.ts:523

getStone

getStone(x, y, stones, _goban): any
Parameters
- x: number
- y: number
- stones: any
- _goban: GobanBase
Returns any
- Defined in Goban/themes/GobanTheme.ts:439

getStoneHash

getStoneHash(x, y, stones, _goban): string
Parameters
- x: number
- y: number
- stones: any
- _goban: GobanBase
Returns string
- Defined in Goban/themes/GobanTheme.ts:455

getWhiteStoneColor

getWhiteStoneColor(): string
Returns string
- Defined in Goban/themes/GobanTheme.ts:474

getWhiteTextColor

getWhiteTextColor(_color?): string
Parameters
- Optional _color: string
Returns string
- Defined in Goban/themes/GobanTheme.ts:484

placeBlackStone

placeBlackStone(ctx, _shadow_ctx, _stone, cx, cy, radius): void
Parameters
- ctx: CanvasRenderingContext2D
- _shadow_ctx: null | CanvasRenderingContext2D
- _stone: any
- cx: number
- cy: number
- radius: number
Returns void
- Defined in Goban/themes/GobanTheme.ts:319

placeBlackStoneSVG

placeBlackStoneSVG(cell, shadow_cell, stone, cx, cy, radius, shadow_theme?): [SVGElement, undefined | SVGElement]
Parameters
- cell: SVGGraphicsElement
- shadow_cell: undefined | SVGGraphicsElement
- stone: string
- cx: number
- cy: number
- radius: number
- shadow_theme: ShadowTheme = "mid"
Returns [SVGElement, undefined | SVGElement]
- Defined in Goban/themes/GobanTheme.ts:424

`Private` placeStoneSVG

placeStoneSVG(cell, shadow_cell, stone, cx, cy, radius, shadow_circle_color, shadow_theme?): [SVGElement, undefined | SVGElement]
Parameters
- cell: SVGGraphicsElement
- shadow_cell: undefined | SVGGraphicsElement
- stone: string
- cx: number
- cy: number
- radius: number
- shadow_circle_color: string
- shadow_theme: ShadowTheme = "mid"
Returns [SVGElement, undefined | SVGElement]
- Defined in Goban/themes/GobanTheme.ts:384

placeStoneShadowSVG

placeStoneShadowSVG(shadow_cell, cx, cy, radius, color, shadow_theme?): undefined | SVGElement
Parameters
- shadow_cell: undefined | SVGGraphicsElement
- cx: number
- cy: number
- radius: number
- color: string
- shadow_theme: ShadowTheme = "mid"
Returns undefined | SVGElement
- Defined in Goban/themes/GobanTheme.ts:334

placeWhiteStone

placeWhiteStone(ctx, _shadow_ctx, _stone, cx, cy, radius): void
Parameters
- ctx: CanvasRenderingContext2D
- _shadow_ctx: null | CanvasRenderingContext2D
- _stone: any
- cx: number
- cy: number
- radius: number
Returns void
- Defined in Goban/themes/GobanTheme.ts:304

placeWhiteStoneSVG

placeWhiteStoneSVG(cell, shadow_cell, stone, cx, cy, radius, shadow_theme?): [SVGElement, undefined | SVGElement]
Parameters
- cell: SVGGraphicsElement
- shadow_cell: undefined | SVGGraphicsElement
- stone: string
- cx: number
- cy: number
- radius: number
- shadow_theme: ShadowTheme = "mid"
Returns [SVGElement, undefined | SVGElement]
- Defined in Goban/themes/GobanTheme.ts:412

preRenderBlack

preRenderBlack(_radius, _seed, _deferredRenderCallback): any
Parameters
- _radius: number
- _seed: number
- _deferredRenderCallback: (() => void)
  - - (): void
    - Returns void
Returns any
- Defined in Goban/themes/GobanTheme.ts:93

preRenderBlackSVG

preRenderBlackSVG(defs, radius, _seed, _deferredRenderCallback): string[]
Parameters
- defs: SVGDefsElement
- radius: number
- _seed: number
- _deferredRenderCallback: (() => void)
  - - (): void
    - Returns void
Returns string[]
- Defined in Goban/themes/GobanTheme.ts:115

preRenderShadowSVG

preRenderShadowSVG(defs, color, shadow_color, shadow_theme?, custom_config?): void
Parameters
- defs: SVGDefsElement
- color: string
- shadow_color: string
- shadow_theme: ShadowTheme = "mid"
- Optional custom_config: CustomShadowConfig
Returns void
- Defined in Goban/themes/GobanTheme.ts:168

preRenderWhite

preRenderWhite(_radius, _seed, _deferredRenderCallback): any
Parameters
- _radius: number
- _seed: number
- _deferredRenderCallback: (() => void)
  - - (): void
    - Returns void
Returns any
- Defined in Goban/themes/GobanTheme.ts:104

preRenderWhiteSVG

preRenderWhiteSVG(defs, radius, _seed, _deferredRenderCallback): string[]
Parameters
- defs: SVGDefsElement
- radius: number
- _seed: number
- _deferredRenderCallback: (() => void)
  - - (): void
    - Returns void
Returns string[]
- Defined in Goban/themes/GobanTheme.ts:143

renderSVG

renderSVG(params, radius): SVGGraphicsElement
Parameters
- params: SVGStoneParameters
- radius: number
Returns SVGGraphicsElement
- Defined in Goban/themes/GobanTheme.ts:548

sort

sort(): number
Returns number
- Defined in Goban/themes/GobanTheme.ts:86

stoneCastsShadow

stoneCastsShadow(_radius): boolean
Parameters
- _radius: number
Returns boolean
- Defined in Goban/themes/GobanTheme.ts:464