Builder
Class: Builder
Section titled “Class: Builder”Helper class for change configurations and create a Vibrant instance. Methods of a Builder instance can be chained like:
Example
Section titled “Example”Vibrant.from(src) .quality(1) .clearFilters() // ... .getPalette() .then((palette) => {})Constructors
Section titled “Constructors”new Builder()
Section titled “new Builder()”new Builder(src, opts): BuilderArguments are the same as Vibrant.constructor.
Parameters
Section titled “Parameters”ImageSource
Partial<Options> = {}
Returns
Section titled “Returns”Defined in
Section titled “Defined in”Methods
Section titled “Methods”addFilter()
Section titled “addFilter()”addFilter(name): BuilderAdds a filter function
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this Builder instance.
Defined in
Section titled “Defined in”build()
Section titled “build()”build(): VibrantBuilds and returns a Vibrant instance as configured.
Returns
Section titled “Returns”Defined in
Section titled “Defined in”clearFilters()
Section titled “clearFilters()”clearFilters(): BuilderClear all filters.
Returns
Section titled “Returns”this Builder instance.
Defined in
Section titled “Defined in”getPalette()
Section titled “getPalette()”getPalette(): Promise<Palette>Builds a Vibrant instance as configured and calls its getPalette method.
Returns
Section titled “Returns”Promise<Palette>
Defined in
Section titled “Defined in”maxColorCount()
Section titled “maxColorCount()”maxColorCount(n): BuilderSets opts.colorCount to n.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this Builder instance.
Defined in
Section titled “Defined in”maxDimension()
Section titled “maxDimension()”maxDimension(d): BuilderSets opts.maxDimension to d.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this Builder instance.
Defined in
Section titled “Defined in”quality()
Section titled “quality()”quality(q): BuilderSets opts.quality to q.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this Builder instance.
Defined in
Section titled “Defined in”removeFilter()
Section titled “removeFilter()”removeFilter(name): BuilderRemoves a filter function.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this Builder instance.
Defined in
Section titled “Defined in”useGenerator()
Section titled “useGenerator()”useGenerator(generator, options?): BuilderSets opts.generator to generator
Parameters
Section titled “Parameters”generator
Section titled “generator”string
options?
Section titled “options?”any
Returns
Section titled “Returns”this Builder instance.
Defined in
Section titled “Defined in”useImageClass()
Section titled “useImageClass()”useImageClass(imageClass): BuilderSpecifies which Image implementation class to use.
Parameters
Section titled “Parameters”imageClass
Section titled “imageClass”ImageClass
Returns
Section titled “Returns”this Builder instance.
Defined in
Section titled “Defined in”useQuantizer()
Section titled “useQuantizer()”useQuantizer(quantizer, options?): BuilderSpecifies which Quantizer implementation class to use
Parameters
Section titled “Parameters”quantizer
Section titled “quantizer”string
options?
Section titled “options?”any
Returns
Section titled “Returns”this Builder instance.