You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api/javascript/class.md
+10Lines changed: 10 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,11 @@ The base class of most Kendo objects. Provides simple inheritance support.
14
14
15
15
An alias to the [prototype](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/prototype) of the class. Often used to call methods of the base class.
16
16
17
+
18
+
<divclass="meta-api-description">
19
+
Accessing or invoking inherited methods, calling or overriding shared prototype functions, manipulating or inspecting base class properties, extending or modifying prototype behavior, controlling or customizing inherited functions, referencing or working with superclass methods, enabling or configuring base functionality reuse, exploring or altering class inheritance features, managing prototype chains, and implementing or adapting parent class behaviors are supported through a mechanism that provides direct access to the class prototype for class inheritance management and base method invocation.
20
+
</div>
21
+
17
22
#### Example - use the prototype to call base methods
18
23
19
24
<script>
@@ -46,6 +51,11 @@ An alias to the [prototype](https://developer.mozilla.org/en-US/docs/Web/JavaScr
46
51
47
52
Extends an existing class with new methods.
48
53
54
+
55
+
<divclass="meta-api-description">
56
+
Extend classes by creating subclasses that add, override, or customize methods and properties to modify or enhance existing functionality, enabling inheritance, method overriding, prototype augmentation, behavior extension, class derivation, subclass creation, mixin integration, and maintaining base class features while introducing new or altered behaviors in the derived class structure.
57
+
</div>
58
+
49
59
#### Returns
50
60
51
61
`Object` a new class which inherits the base methods.
Copy file name to clipboardExpand all lines: docs/api/javascript/color.md
+75Lines changed: 75 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,6 +31,11 @@ the methods below.
31
31
32
32
Computes the relative luminance between two colors.
33
33
34
+
35
+
<divclass="meta-api-description">
36
+
Calculate and compare the brightness difference or contrast ratio between two colors to evaluate visual accessibility, assess relative luminance, determine color contrast compliance with standards like WCAG, measure lightness disparities, and enable programmatic checks for sufficient contrast in UI design or color schemes. This function supports inputting any two colors to return a numeric value representing the luminance gap, useful for ensuring readability, controlling color visibility, validating design contrast requirements, or dynamically comparing color brightness levels in applications.
37
+
</div>
38
+
34
39
#### Returns
35
40
36
41
`Number` The relative luminance.
@@ -56,6 +61,11 @@ Computes the relative luminance between two colors.
56
61
57
62
Compares two color objects for equality.
58
63
64
+
65
+
<divclass="meta-api-description">
66
+
Check if two color objects are the same by comparing their color values, determine color equality for matching or filtering colors, identify duplicates in color collections, verify if colors have changed, or validate that two color instances represent identical hues using equality comparison methods for colors.
67
+
</div>
68
+
59
69
#### Returns
60
70
61
71
`Boolean` returns `true` if the two colors are the same. Otherwise, `false`
@@ -85,6 +95,11 @@ following properties:
85
95
86
96
This does not modify the current object, it creates a new one instead.
87
97
98
+
99
+
<divclass="meta-api-description">
100
+
Convert any color to its hue-saturation-value-alpha (HSVA) format to access or extract hue degrees, saturation ratios, brightness levels, and transparency values for tasks like color adjustments, dynamic UI components, color picker integration, visual effects, or color space transformations. Enable retrieving and manipulating color properties as numeric values or objects for use in styling, comparisons, blending, or graphical controls without altering the original color data. Whether you need HSV conversion for design tools, theme customization, or programmatic color analysis, this method provides precise HSVA components formatted for flexible usage and color workflow integration.
101
+
</div>
102
+
88
103
#### Returns
89
104
`Object` An object with h, s, v and a fields.
90
105
@@ -109,6 +124,11 @@ properties:
109
124
110
125
This does not modify the current object, it creates a new one instead.
111
126
127
+
128
+
<divclass="meta-api-description">
129
+
Convert a color value to its numeric red, green, blue, and alpha components represented as floating-point numbers between 0 and 1, enabling extraction of explicit RGBA channels from any color object for tasks like color manipulation, filtering, or blending; retrieve individual channel intensities in a structured format without altering the original color, useful for converting colors into numeric arrays, accessing transparency levels, or preparing color data for graphics processing and shader inputs.
130
+
</div>
131
+
112
132
#### Returns
113
133
114
134
`Object` An object with r, g, b and a fields.
@@ -129,6 +149,11 @@ RGB, but `r`, `g` and `b` are integers between 0 and 255 instead of floats.
129
149
130
150
This does not modify the current object, it creates a new one instead.
131
151
152
+
153
+
<divclass="meta-api-description">
154
+
Transform a floating-point RGB color representation into an integer-based format with red, green, and blue channels scaled from 0 to 255, enabling conversion between decimal color values and byte-level color components, extracting color values as integer RGB objects for image processing, graphics manipulation, or serialization tasks, generating new color objects with integer RGB channels without altering the original color data, and facilitating workflows requiring precise integer color channel handling or byte array creation from color objects.
155
+
</div>
156
+
132
157
#### Returns
133
158
`Object` An object with r, g and b fields.
134
159
@@ -145,6 +170,11 @@ This does not modify the current object, it creates a new one instead.
145
170
146
171
Returns a string in `"FF0000"` form (without a leading `#`).
147
172
173
+
174
+
<divclass="meta-api-description">
175
+
Convert color values into compact six-character hexadecimal strings commonly used in CSS styling, color serialization, or color comparison tasks without the leading '#' symbol. Generate hex codes for colors to enable easy transmission, storage, or matching of color data in formats like "FF0000" for red. Transform color representations into standard hex format for use in web design, data exchange, and string-based color operations, supporting tasks like formatting, encoding, or comparing color objects in hex notation.
176
+
</div>
177
+
148
178
#### Returns
149
179
150
180
`String` The color in hex notation.
@@ -161,6 +191,11 @@ Returns a string in `"FF0000"` form (without a leading `#`).
161
191
162
192
Like `toHex`, but includes a leading `#`.
163
193
194
+
195
+
<divclass="meta-api-description">
196
+
Generate a hexadecimal color string prefixed with a hash symbol for use in CSS styles, convert color objects to web-compatible hex codes, obtain CSS-ready color values from color instances, produce strings formatted for CSS color properties, enable converting color data into standard #RRGGBB format for style assignments, set colors in HTML or stylesheet contexts using hex notation, translate color representations to CSS hex strings, create web-friendly color strings from color instances, output color codes for use in inline styles or CSS files, and format colors as hash-prefixed hexadecimal strings compatible with CSS color specifications.
197
+
</div>
198
+
164
199
#### Returns
165
200
166
201
`String` The color in CSS notation.
@@ -177,6 +212,11 @@ Like `toHex`, but includes a leading `#`.
177
212
178
213
Returns the color in RGBA notation (includes the opacity).
179
214
215
+
216
+
<divclass="meta-api-description">
217
+
Convert a color object to a CSS-ready RGBA string representation that includes red, green, blue, and alpha transparency components, enabling seamless integration into inline styles, CSS rules, canvas rendering, or dynamic style updates; generate the "rgba(r,g,b,a)" format for assigning colors with opacity, serializing color values for stylesheets, or applying precise transparency in web design and graphics contexts.
218
+
</div>
219
+
180
220
#### Returns
181
221
182
222
`String` The color in RGBA notation.
@@ -199,6 +239,11 @@ Returns the color in the best notation supported by the current browser. In
199
239
IE < 9 this returns the `#FF0000` form; in all other browsers it returns the
200
240
RGBA form.
201
241
242
+
243
+
<divclass="meta-api-description">
244
+
Convert color objects to browser-compatible CSS color strings, automatically choosing the optimal format such as legacy hex codes like #FF0000 for older browsers or modern RGBA strings for enhanced color precision and transparency support, enabling developers to retrieve display-ready CSS color values adaptable to different browser environments and rendering capabilities.
245
+
</div>
246
+
202
247
#### Returns
203
248
204
249
`String` The color in the best notation supported by the current browser.
@@ -218,6 +263,11 @@ RGBA form.
218
263
219
264
The red channel of the color, in the range from 0 to 1.
220
265
266
+
267
+
<divclass="meta-api-description">
268
+
Adjust, set, or retrieve the red channel intensity in a color component using a normalized value between 0 and 1; customize or manipulate the amount of red for color blending, RGBA color adjustments, fine-tuning hues, or dynamic color transformations by reading or updating this red intensity value within color objects.
269
+
</div>
270
+
221
271
#### Example
222
272
223
273
<script>
@@ -234,6 +284,11 @@ The red channel of the color, in the range from 0 to 1.
234
284
235
285
The green channel of the color, in the range from 0 to 1.
236
286
287
+
288
+
<divclass="meta-api-description">
289
+
Control or retrieve the green color intensity in a color value by setting or reading the green channel, typically represented as a normalized value between 0 and 1, where 0 means no green and 1 means full green intensity. Adjust or configure the green component in RGBA colors for fine-tuning color blending, shading, or color correction in graphic, UI, or rendering contexts. Modify the green channel alongside red, blue, and alpha channels to achieve precise color manipulation, saturation control, or color composition in applications, shaders, or color transformations.
290
+
</div>
291
+
237
292
#### Example
238
293
239
294
<script>
@@ -250,6 +305,11 @@ The green channel of the color, in the range from 0 to 1.
250
305
251
306
The blue channel of the color, in the range from 0 to 1.
252
307
308
+
309
+
<divclass="meta-api-description">
310
+
Access or modify the blue color intensity component in a color object, enabling retrieval, adjustment, or comparison of the blue channel value within RGB color models using normalized floating-point numbers from zero to one. Control blue saturation or brightness, set precise RGB blue levels, read current blue intensity for color manipulation, or configure color blending and rendering based on the blue channel value. This supports tasks like dynamic color adjustments, color matching, and fine-tuning blue shades in gradients or digital graphics workflows.
311
+
</div>
312
+
253
313
#### Example
254
314
255
315
<script>
@@ -269,6 +329,11 @@ The blue channel of the color, in the range from 0 to 1.
269
329
270
330
Creates a new color object from the rgba channels in the 0..1 range.
271
331
332
+
333
+
<divclass="meta-api-description">
334
+
Generate or define colors by specifying red, green, blue, and alpha channels using normalized values between 0 and 1 for precise color creation, conversion, or manipulation. Configure colors from fractional RGBa components to programmatically set or update hues, tints, transparency levels, and opacity with fine-grained control over color channels in normalized form. Enable color construction, blending, or dynamic color adjustments by inputting normalized floating-point values for red, green, blue, and alpha, useful for color computations, transformations, or UI theming. Use normalized channel values to create color instances that support real-time color changes, shading calculations, and compositing with precise alpha transparency handling.
335
+
</div>
336
+
272
337
#### Parameters
273
338
274
339
##### red `Number`
@@ -307,6 +372,11 @@ The alpha channel of the color, in the range from 0 to 1. Defaults to 1 when omi
307
372
308
373
Creates a new color object from the hsva channels in the 0..1 range.
309
374
375
+
376
+
<divclass="meta-api-description">
377
+
Generate or instantiate colors by specifying hue, saturation, value, and alpha using normalized values between 0 and 1, enabling precise control over color creation from HSVA channels for custom color manipulation, dynamic color generation, and runtime color adjustments with transparency and vividness settings.
378
+
</div>
379
+
310
380
#### Parameters
311
381
312
382
##### hue `Number`
@@ -345,6 +415,11 @@ The alpha channel of the color, in the range from 0 to 1. Defaults to 1 when omi
345
415
346
416
Creates a new color object from the rgba channels in the 0..255 range.
347
417
418
+
419
+
<divclass="meta-api-description">
420
+
Generate or build a color using separate red, green, blue, and alpha channel values expressed as integers from 0 to 255, enabling conversion from byte arrays, image data, network streams, or binary inputs into a usable color object; configure or set color components based on raw RGBA bytes to represent transparency and color intensity accurately for UI elements, graphical rendering, or color manipulation tasks where byte-level color data is provided or needs decoding.
Copy file name to clipboardExpand all lines: docs/api/javascript/data/binder.md
+20Lines changed: 20 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,11 @@ The base class of the Kendo UI MVVM-style bindings. Creates custom MVVM bindings
15
15
16
16
Represents all bindings applied to the current HTML [element](/api/javascript/data/binder#fields-element). Gets or sets the current view-model field value.
17
17
18
+
19
+
<divclass="meta-api-description">
20
+
Retrieve or modify all data bindings associated with a specific HTML element within a Binder component, enabling inspection, iteration, or synchronization of bound values between the element and its view-model fields. Control or access the collection of binding entries attached to the element to programmatically get or set bound data, update fields, manage binding states, and interact with data synchronization after initialization, supporting scenarios like dynamic binding updates, real-time data manipulation, and binding state inspection for effective two-way data binding management.
21
+
</div>
22
+
18
23
#### Example - get the view model field
19
24
20
25
<div data-bind="slide: slideChecked" style="background: orange; width: 100px; height: 100px"></div>
@@ -42,6 +47,11 @@ Represents all bindings applied to the current HTML [element](/api/javascript/da
42
47
43
48
The bound HTML element.
44
49
50
+
51
+
<divclass="meta-api-description">
52
+
Retrieve or interact with the specific HTML DOM node linked to a data-binding or UI synchronization component, allowing developers to read or modify the element’s attributes, inner content, CSS styles, event handlers, or other properties on the associated DOM element after binding setup. This direct reference supports manipulation or inspection of the bound node for tasks such as dynamic updates, event delegation, style adjustments, attribute toggling, and other front-end element management scenarios involving components that connect data or logic to specific HTML elements.
53
+
</div>
54
+
45
55
#### Example - use the HTML element of the Binder
46
56
47
57
<div data-bind="slide: slideChecked" style="background: orange; width: 100px; height: 100px"></div>
@@ -70,6 +80,11 @@ The bound HTML element.
70
80
71
81
Creates a new binding which inherits from the `kendo.data.Binder` class.
72
82
83
+
84
+
<divclass="meta-api-description">
85
+
Create or customize data-binding behavior by defining new binder types that inherit and extend existing binding classes, enabling you to implement custom MVVM or data-binding logic, override or add methods for how data connects to UI components, control DOM updates, configure specialized bind and unbind processes, and tailor the way data flows and updates synchronize between models and views through subclassing binding constructors.
86
+
</div>
87
+
73
88
#### Returns
74
89
75
90
`Object`—A new class which inherits the base methods.
@@ -130,6 +145,11 @@ A key/value pair of all methods that the new class will have.
130
145
131
146
Invoked by the Kendo UI MVVM framework when the bound view-model value is changed. The Binder should update the UI (the HTML element or the Kendo UI widget) to reflect the view-model change.
132
147
148
+
149
+
<divclass="meta-api-description">
150
+
Refresh or update user interface elements based on changes in bound data models, enabling synchronization between view-model values and displayed content; configure dynamic UI refreshing by implementing methods that detect data updates, re-render components, apply new attributes, manage formatting changes, and maintain the current state of HTML elements or UI widgets, ensuring that data binding reflects the most recent model state across various scenarios and custom components.
151
+
</div>
152
+
133
153
#### Example - slide up or down the element when the bound value changes
134
154
135
155
<div data-bind="slide: slideChecked" style="background: orange; width: 100px; height: 100px"></div>
0 commit comments