API
API
PivotIconRegistry

PivotIconRegistry

์…€ overlay์—์„œ ์‚ฌ์šฉ๋˜๋Š” ์•„์ด์ฝ˜ + ์•„์ด์ฝ˜ ์„ธํŠธ์˜ ๊ธ€๋กœ๋ฒŒ ๋ ˆ์ง€์ŠคํŠธ๋ฆฌ.

  • ๋นŒํŠธ์ธ ์•„์ด์ฝ˜๊ณผ ์„ธํŠธ๋Š” ๋ชจ๋“ˆ ๋กœ๋“œ ์‹œ ์ž๋™ ๋“ฑ๋ก๋œ๋‹ค.
  • ์‚ฌ์šฉ์ž๋Š” registerIcon / registerSet์œผ๋กœ ์ž์ฒด ์•„์ด์ฝ˜์„ ์ถ”๊ฐ€ํ•  ์ˆ˜ ์žˆ๋‹ค.
  • DOM ํ™˜๊ฒฝ์—์„œ๋Š” ์ฒซ lookup ์‹œ builtin๋“ค์˜ CSS๊ฐ€ <head>์— ์ž๋™ ์ฃผ์ž…๋œ๋‹ค. ์‚ฌ์šฉ์ž ๋“ฑ๋ก ์•„์ด์ฝ˜์€ registerIcon ํ˜ธ์ถœ ์‹œ ์ฆ‰์‹œ ์ฃผ์ž…๋œ๋‹ค.

Methods

static ensureStyles(doc): void (opens in a new tab)

DOM์— ๋นŒํŠธ์ธ ์•„์ด์ฝ˜ CSS๊ฐ€ ์ฃผ์ž…๋˜์–ด ์žˆ๋Š”์ง€ ๋ณด์žฅ. cell view์—์„œ(๋งŒ) ํ˜ธ์ถœํ•˜๋ฏ€๋กœ document๋Š” ๋ณด์žฅ ๋œ๋‹ค.

ParameterType
docDocument (opens in a new tab)

static getIcon(name): IconDef

๋“ฑ๋ก๋œ ์•„์ด์ฝ˜ ์ •์˜ ๋ฐ˜ํ™˜. ์—†์œผ๋ฉด undefined.

ParameterType
namestring (opens in a new tab)

static getSet(name): IconSetDef

๋“ฑ๋ก๋œ ์•„์ด์ฝ˜ ์„ธํŠธ ๋ฐ˜ํ™˜. ์—†์œผ๋ฉด undefined.

ParameterType
namestring (opens in a new tab)

static iconNames(): Array (opens in a new tab)<string (opens in a new tab)>

๋“ฑ๋ก๋œ ์•„์ด์ฝ˜ ์ด๋ฆ„ ๋ชฉ๋ก.

static registerSet(name, icons, colorable?): void (opens in a new tab)

์‚ฌ์šฉ์ž ์ •์˜ ์•„์ด์ฝ˜ ์„ธํŠธ๋ฅผ ๋“ฑ๋กํ•œ๋‹ค.

  • ๋ฌธ์ž์—ด: ์ด๋ฏธ ๋“ฑ๋ก๋œ ์•„์ด์ฝ˜ ์ด๋ฆ„.
  • [name, svg] ํŠœํ”Œ: SVG ๋ฌธ์ž์—ด๋กœ ์•„์ด์ฝ˜์„ ๋“ฑ๋กํ•˜๋ฉด์„œ ์„ธํŠธ์— ์ถ”๊ฐ€. colorable ์ ์šฉ.
ParameterTypeDescription
namestring (opens in a new tab)
iconsArray (opens in a new tab)<string (opens in a new tab)[string (opens in a new tab) | string (opens in a new tab)]>
colorable=falseboolean (opens in a new tab)ํŠœํ”Œ๋กœ ๋“ฑ๋ก๋˜๋Š” ์•„์ด์ฝ˜์— ์ ์šฉํ•  colorable ๊ฐ’ (๊ธฐ๋ณธ false)

static setNames(): Array (opens in a new tab)<string (opens in a new tab)>

๋“ฑ๋ก๋œ ์„ธํŠธ ์ด๋ฆ„ ๋ชฉ๋ก.