Chrome DevTools Protocol

Methods

CSS.addRule

Inserts a new rule with the given ruleText in a stylesheet with given styleSheetId, at the position specified by location.

parameters
styleSheetId
StyleSheetId

The css style sheet identifier where a new rule should be inserted.

ruleText
string

The text of a new rule.

location
SourceRange

Text position of a new rule in the target style sheet.

Return Object
rule
CSSRule

The newly created rule.

CSS.collectClassNames

Returns all class names from specified stylesheet.

parameters
styleSheetId
StyleSheetId
Return Object
classNames
array[ string ]

Class name list.

CSS.createStyleSheet

Creates a new special "via-inspector" stylesheet in the frame with given frameId.

parameters
frameId
Page.FrameId

Identifier of the frame where "via-inspector" stylesheet should be created.

Return Object
styleSheetId
StyleSheetId

Identifier of the created "via-inspector" stylesheet.

CSS.disable

Disables the CSS agent for the given page.

CSS.enable

Enables the CSS agent for the given page. Clients should not assume that the CSS agent has been enabled until the result of this command is received.

CSS.forcePseudoState

Ensures that the given node will have specified pseudo-classes whenever its style is computed by the browser.

parameters
nodeId
DOM.NodeId

The element id for which to force the pseudo state.

forcedPseudoClasses
array[ string ]

Element pseudo classes to force when computing the element's style.

CSS.getBackgroundColors

parameters
nodeId
DOM.NodeId

Id of the node to get background colors for.

Return Object
backgroundColors
array[ string ]

The range of background colors behind this element, if it contains any visible text. If no visible text is present, this will be undefined. In the case of a flat background color, this will consist of simply that color. In the case of a gradient, this will consist of each of the color stops. For anything more complicated, this will be an empty array. Images will be ignored (as if the image had failed to load).

computedFontSize
string

The computed font size for this node, as a CSS computed value string (e.g. '12px').

computedFontWeight
string

The computed font weight for this node, as a CSS computed value string (e.g. 'normal' or '100').

CSS.getComputedStyleForNode

Returns the computed style for a DOM node identified by nodeId.

parameters
nodeId
DOM.NodeId
Return Object
computedStyle
array[ CSSComputedStyleProperty ]

Computed style for the specified DOM node.

CSS.getInlineStylesForNode

Returns the styles defined inline (explicitly in the "style" attribute and implicitly, using DOM attributes) for a DOM node identified by nodeId.

parameters
nodeId
DOM.NodeId
Return Object
inlineStyle
CSSStyle

Inline style for the specified DOM node.

attributesStyle
CSSStyle

Attribute-defined element style (e.g. resulting from "width=20 height=100%").

CSS.getMatchedStylesForNode

Returns requested styles for a DOM node identified by nodeId.

parameters
nodeId
DOM.NodeId
Return Object
inlineStyle
CSSStyle

Inline style for the specified DOM node.

attributesStyle
CSSStyle

Attribute-defined element style (e.g. resulting from "width=20 height=100%").

matchedCSSRules
array[ RuleMatch ]

CSS rules matching this node, from all applicable stylesheets.

pseudoElements
array[ PseudoElementMatches ]

Pseudo style matches for this node.

inherited
array[ InheritedStyleEntry ]

A chain of inherited styles (from the immediate node parent up to the DOM tree root).

cssKeyframesRules
array[ CSSKeyframesRule ]

A list of CSS keyframed animations matching this node.

CSS.getMediaQueries

Returns all media queries parsed by the rendering engine.

Return Object
medias
array[ CSSMedia ]

CSS.getPlatformFontsForNode

Requests information about platform fonts which we used to render child TextNodes in the given node.

parameters
nodeId
DOM.NodeId
Return Object
fonts
array[ PlatformFontUsage ]

Usage statistics for every employed platform font.

CSS.getStyleSheetText

Returns the current textual content for a stylesheet.

parameters
styleSheetId
StyleSheetId
Return Object
text
string

The stylesheet text.

CSS.setEffectivePropertyValueForNode

Find a rule with the given active property for the given node and set the new value for this property

parameters
nodeId
DOM.NodeId

The element id for which to set property.

propertyName
string
value
string

CSS.setKeyframeKey

Modifies the keyframe rule key text.

parameters
styleSheetId
StyleSheetId
range
SourceRange
keyText
string
Return Object
keyText
Value

The resulting key text after modification.

CSS.setMediaText

Modifies the rule selector.

parameters
styleSheetId
StyleSheetId
range
SourceRange
text
string
Return Object
media
CSSMedia

The resulting CSS media rule after modification.

CSS.setRuleSelector

Modifies the rule selector.

parameters
styleSheetId
StyleSheetId
range
SourceRange
selector
string
Return Object
selectorList
SelectorList

The resulting selector list after modification.

CSS.setStyleSheetText

Sets the new stylesheet text.

parameters
styleSheetId
StyleSheetId
text
string
Return Object
sourceMapURL
string

URL of source map associated with script (if any).

CSS.setStyleTexts

Applies specified style edits one after another in the given order.

parameters
edits
array[ StyleDeclarationEdit ]
Return Object
styles
array[ CSSStyle ]

The resulting styles after modification.

CSS.startRuleUsageTracking

Enables the selector recording.

CSS.stopRuleUsageTracking

Stop tracking rule usage and return the list of rules that were used since last call to takeCoverageDelta (or since start of coverage instrumentation)

Return Object
ruleUsage
array[ RuleUsage ]

CSS.takeCoverageDelta

Obtain list of rules that became used since last call to this method (or since start of coverage instrumentation)

Return Object
coverage
array[ RuleUsage ]
timestamp
number

Monotonically increasing time, in seconds.

CSS.setLocalFontsEnabled Experimental

Enables/disables rendering of local CSS fonts (enabled by default).

parameters
enabled
boolean

Whether rendering of local fonts is enabled.

CSS.takeComputedStyleUpdates Experimental

Polls the next batch of computed style updates.

Return Object
nodeIds
array[ DOM.NodeId ]

The list of node Ids that have their tracked computed styles updated

CSS.trackComputedStyleUpdates Experimental

Starts tracking the given computed styles for updates. The specified array of properties replaces the one previously specified. Pass empty array to disable tracking. Use takeComputedStyleUpdates to retrieve the list of nodes that had properties modified. The changes to computed style properties are only tracked for nodes pushed to the front-end by the DOM agent. If no changes to the tracked properties occur after the node has been pushed to the front-end, no updates will be issued for the node.

parameters
propertiesToTrack
array[ CSSComputedStyleProperty ]

Events

CSS.fontsUpdated

Fires whenever a web font is updated. A non-empty font parameter indicates a successfully loaded web font

parameters
font
FontFace

The web font that has loaded.

CSS.mediaQueryResultChanged

Fires whenever a MediaQuery result changes (for example, after a browser window has been resized.) The current implementation considers only viewport-dependent media features.

CSS.styleSheetAdded

Fired whenever an active document stylesheet is added.

parameters
header
CSSStyleSheetHeader

Added stylesheet metainfo.

CSS.styleSheetChanged

Fired whenever a stylesheet is changed as a result of the client operation.

parameters
styleSheetId
StyleSheetId

CSS.styleSheetRemoved

Fired whenever an active document stylesheet is removed.

parameters
styleSheetId
StyleSheetId

Identifier of the removed stylesheet.

Types

CSS.CSSComputedStyleProperty

Type: object

properties
name
string

Computed style property name.

value
string

Computed style property value.

CSS.CSSKeyframeRule

CSS keyframe rule representation.

Type: object

properties
styleSheetId
StyleSheetId

The css style sheet identifier (absent for user agent stylesheet and user-specified stylesheet rules) this rule came from.

origin
StyleSheetOrigin

Parent stylesheet's origin.

keyText
Value

Associated key text.

style
CSSStyle

Associated style declaration.

CSS.CSSKeyframesRule

CSS keyframes rule representation.

Type: object

properties
animationName
Value

Animation name.

keyframes
array[ CSSKeyframeRule ]

List of keyframes.

CSS.CSSMedia

CSS media rule descriptor.

Type: object

properties
text
string

Media query text.

source
string

Source of the media query: "mediaRule" if specified by a @media rule, "importRule" if specified by an @import rule, "linkedSheet" if specified by a "media" attribute in a linked stylesheet's LINK tag, "inlineSheet" if specified by a "media" attribute in an inline stylesheet's STYLE tag.

Allowed Values: mediaRule, importRule, linkedSheet, inlineSheet
sourceURL
string

URL of the document containing the media query description.

range
SourceRange

The associated rule (@media or @import) header range in the enclosing stylesheet (if available).

styleSheetId
StyleSheetId

Identifier of the stylesheet containing this object (if exists).

mediaList
array[ MediaQuery ]

Array of media queries.

CSS.CSSProperty

CSS property declaration data.

Type: object

properties
name
string

The property name.

value
string

The property value.

important
boolean

Whether the property has "!important" annotation (implies false if absent).

implicit
boolean

Whether the property is implicit (implies false if absent).

text
string

The full property text as specified in the style.

parsedOk
boolean

Whether the property is understood by the browser (implies true if absent).

disabled
boolean

Whether the property is disabled by the user (present for source-based properties only).

range
SourceRange

The entire property range in the enclosing style declaration (if available).

CSS.CSSRule

CSS rule representation.

Type: object

properties
styleSheetId
StyleSheetId

The css style sheet identifier (absent for user agent stylesheet and user-specified stylesheet rules) this rule came from.

selectorList
SelectorList

Rule selector data.

origin
StyleSheetOrigin

Parent stylesheet's origin.

style
CSSStyle

Associated style declaration.

media
array[ CSSMedia ]

Media list array (for rules involving media queries). The array enumerates media queries starting with the innermost one, going outwards.

CSS.CSSStyle

CSS style representation.

Type: object

properties
styleSheetId
StyleSheetId

The css style sheet identifier (absent for user agent stylesheet and user-specified stylesheet rules) this rule came from.

cssProperties
array[ CSSProperty ]

CSS properties in the style.

shorthandEntries
array[ ShorthandEntry ]

Computed values for all shorthands found in the style.

cssText
string

Style declaration text (if available).

range
SourceRange

Style declaration range in the enclosing stylesheet (if available).

CSS.CSSStyleSheetHeader

CSS stylesheet metainformation.

Type: object

properties
styleSheetId
StyleSheetId

The stylesheet identifier.

frameId
Page.FrameId

Owner frame identifier.

sourceURL
string

Stylesheet resource URL.

sourceMapURL
string

URL of source map associated with the stylesheet (if any).

origin
StyleSheetOrigin

Stylesheet origin.

title
string

Stylesheet title.

ownerNode
DOM.BackendNodeId

The backend id for the owner node of the stylesheet.

disabled
boolean

Denotes whether the stylesheet is disabled.

hasSourceURL
boolean

Whether the sourceURL field value comes from the sourceURL comment.

isInline
boolean

Whether this stylesheet is created for STYLE tag by parser. This flag is not set for document.written STYLE tags.

isMutable
boolean

Whether this stylesheet is mutable. Inline stylesheets become mutable after they have been modified via CSSOM API.

element's stylesheets are never mutable. Constructed stylesheets (new CSSStyleSheet()) are mutable immediately after creation.
startLine
number

Line offset of the stylesheet within the resource (zero based).

startColumn
number

Column offset of the stylesheet within the resource (zero based).

length
number

Size of the content (in characters).

endLine
number

Line offset of the end of the stylesheet within the resource (zero based).

endColumn
number

Column offset of the end of the stylesheet within the resource (zero based).

CSS.FontFace

Properties of a web font: https://www.w3.org/TR/2008/REC-CSS2-20080411/fonts.html#font-descriptions and additional information such as platformFontFamily and fontVariationAxes.

Type: object

properties
fontFamily
string

The font-family.

fontStyle
string

The font-style.

fontVariant
string

The font-variant.

fontWeight
string

The font-weight.

fontStretch
string

The font-stretch.

unicodeRange
string

The unicode-range.

src
string

The src.

platformFontFamily
string

The resolved platform font family

fontVariationAxes
array[ FontVariationAxis ]

Available variation settings (a.k.a. "axes").

CSS.FontVariationAxis

Information about font variation axes for variable fonts

Type: object

properties
tag
string

The font-variation-setting tag (a.k.a. "axis tag").

name
string

Human-readable variation name in the default language (normally, "en").

minValue
number

The minimum value (inclusive) the font supports for this tag.

maxValue
number

The maximum value (inclusive) the font supports for this tag.

defaultValue
number

The default value.

CSS.InheritedStyleEntry

Inherited CSS rule collection from ancestor node.

Type: object

properties
inlineStyle
CSSStyle

The ancestor node's inline style, if any, in the style inheritance chain.

matchedCSSRules
array[ RuleMatch ]

Matches of CSS rules matching the ancestor node in the style inheritance chain.

CSS.MediaQuery

Media query descriptor.

Type: object

properties
expressions
array[ MediaQueryExpression ]

Array of media query expressions.

active
boolean

Whether the media query condition is satisfied.

CSS.MediaQueryExpression

Media query expression descriptor.

Type: object

properties
value
number

Media query expression value.

unit
string

Media query expression units.

feature
string

Media query expression feature.

valueRange
SourceRange

The associated range of the value text in the enclosing stylesheet (if available).

computedLength
number

Computed length of media query expression (if applicable).

CSS.PlatformFontUsage

Information about amount of glyphs that were rendered with given font.

Type: object

properties
familyName
string

Font's family name reported by platform.

isCustomFont
boolean

Indicates if the font was downloaded or resolved locally.

glyphCount
number

Amount of glyphs that were rendered with this font.

CSS.PseudoElementMatches

CSS rule collection for a single pseudo style.

Type: object

properties
pseudoType
DOM.PseudoType

Pseudo element type.

matches
array[ RuleMatch ]

Matches of CSS rules applicable to the pseudo style.

CSS.RuleMatch

Match data for a CSS rule.

Type: object

properties
rule
CSSRule

CSS rule in the match.

matchingSelectors
array[ integer ]

Matching selector indices in the rule's selectorList selectors (0-based).

CSS.RuleUsage

CSS coverage information.

Type: object

properties
styleSheetId
StyleSheetId

The css style sheet identifier (absent for user agent stylesheet and user-specified stylesheet rules) this rule came from.

startOffset
number

Offset of the start of the rule (including selector) from the beginning of the stylesheet.

endOffset
number

Offset of the end of the rule body from the beginning of the stylesheet.

used
boolean

Indicates whether the rule was actually used by some element in the page.

CSS.SelectorList

Selector list data.

Type: object

properties
selectors
array[ Value ]

Selectors in the list.

text
string

Rule selector text.

CSS.ShorthandEntry

Type: object

properties
name
string

Shorthand name.

value
string

Shorthand value.

important
boolean

Whether the property has "!important" annotation (implies false if absent).

CSS.SourceRange

Text range within a resource. All numbers are zero-based.

Type: object

properties
startLine
integer

Start line of range.

startColumn
integer

Start column of range (inclusive).

endLine
integer

End line of range

endColumn
integer

End column of range (exclusive).

CSS.StyleDeclarationEdit

A descriptor of operation to mutate style declaration text.

Type: object

properties
styleSheetId
StyleSheetId

The css style sheet identifier.

range
SourceRange

The range of the style text in the enclosing stylesheet.

text
string

New style text.

CSS.StyleSheetId

Type: string

CSS.StyleSheetOrigin

Stylesheet type: "injected" for stylesheets injected via extension, "user-agent" for user-agent stylesheets, "inspector" for stylesheets created by the inspector (i.e. those holding the "via inspector" rules), "regular" for regular stylesheets.

Allowed Values: injected, user-agent, inspector, regular

Type: string

CSS.Value

Data for a simple selector (these are delimited by commas in a selector list).

Type: object

properties
text
string

Value text.

range
SourceRange

Value range in the underlying resource (if available).