excel.interfaces.databarconditionalformatdata.yml

### YamlMime:TSType
name: Excel.Interfaces.DataBarConditionalFormatData
uid: 'excel!Excel.Interfaces.DataBarConditionalFormatData:interface'
package: excel!
fullName: Excel.Interfaces.DataBarConditionalFormatData
summary: An interface describing the data returned by calling `dataBarConditionalFormat.toJSON()`<!-- -->.
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: axisColor
    uid: 'excel!Excel.Interfaces.DataBarConditionalFormatData#axisColor:member'
    package: excel!
    fullName: axisColor
    summary: >-
      HTML color code representing the color of the Axis line, in the form \#RRGGBB (e.g., "FFA500") or as a named HTML
      color (e.g., "orange"). Value is "" (an empty string) if no axis is present or set.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'axisColor?: string;'
      return:
        type: string
  - name: axisFormat
    uid: 'excel!Excel.Interfaces.DataBarConditionalFormatData#axisFormat:member'
    package: excel!
    fullName: axisFormat
    summary: Representation of how the axis is determined for an Excel data bar.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'axisFormat?: Excel.ConditionalDataBarAxisFormat | "Automatic" | "None" | "CellMidPoint";'
      return:
        type: '<xref uid="excel!Excel.ConditionalDataBarAxisFormat:enum" /> | "Automatic" | "None" | "CellMidPoint"'
  - name: barDirection
    uid: 'excel!Excel.Interfaces.DataBarConditionalFormatData#barDirection:member'
    package: excel!
    fullName: barDirection
    summary: Specifies the direction that the data bar graphic should be based on.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'barDirection?: Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft";'
      return:
        type: '<xref uid="excel!Excel.ConditionalDataBarDirection:enum" /> | "Context" | "LeftToRight" | "RightToLeft"'
  - name: lowerBoundRule
    uid: 'excel!Excel.Interfaces.DataBarConditionalFormatData#lowerBoundRule:member'
    package: excel!
    fullName: lowerBoundRule
    summary: >-
      The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar. The
      `ConditionalDataBarRule` object must be set as a JSON object (use `x.lowerBoundRule = {...}` instead of
      `x.lowerBoundRule.formula = ...`<!-- -->).
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'lowerBoundRule?: Excel.ConditionalDataBarRule;'
      return:
        type: '<xref uid="excel!Excel.ConditionalDataBarRule:interface" />'
  - name: negativeFormat
    uid: 'excel!Excel.Interfaces.DataBarConditionalFormatData#negativeFormat:member'
    package: excel!
    fullName: negativeFormat
    summary: Representation of all values to the left of the axis in an Excel data bar.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'negativeFormat?: Excel.Interfaces.ConditionalDataBarNegativeFormatData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ConditionalDataBarNegativeFormatData:interface" />'
  - name: positiveFormat
    uid: 'excel!Excel.Interfaces.DataBarConditionalFormatData#positiveFormat:member'
    package: excel!
    fullName: positiveFormat
    summary: Representation of all values to the right of the axis in an Excel data bar.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'positiveFormat?: Excel.Interfaces.ConditionalDataBarPositiveFormatData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ConditionalDataBarPositiveFormatData:interface" />'
  - name: showDataBarOnly
    uid: 'excel!Excel.Interfaces.DataBarConditionalFormatData#showDataBarOnly:member'
    package: excel!
    fullName: showDataBarOnly
    summary: 'If `true`<!-- -->, hides the values from the cells where the data bar is applied.'
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'showDataBarOnly?: boolean;'
      return:
        type: boolean
  - name: upperBoundRule
    uid: 'excel!Excel.Interfaces.DataBarConditionalFormatData#upperBoundRule:member'
    package: excel!
    fullName: upperBoundRule
    summary: >-
      The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar. The
      `ConditionalDataBarRule` object must be set as a JSON object (use `x.upperBoundRule = {...}` instead of
      `x.upperBoundRule.formula = ...`<!-- -->).
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'upperBoundRule?: Excel.ConditionalDataBarRule;'
      return:
        type: '<xref uid="excel!Excel.ConditionalDataBarRule:interface" />'