excel.interfaces.databarconditionalformatloadoptions.yml

### YamlMime:TSType
name: Excel.Interfaces.DataBarConditionalFormatLoadOptions
uid: 'excel!Excel.Interfaces.DataBarConditionalFormatLoadOptions:interface'
package: excel!
fullName: Excel.Interfaces.DataBarConditionalFormatLoadOptions
summary: Represents an Excel conditional data bar type.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: $all
    uid: 'excel!Excel.Interfaces.DataBarConditionalFormatLoadOptions#$all:member'
    package: excel!
    fullName: $all
    summary: >-
      Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`<!-- -->) but not the
      navigational properties (e.g.: `Range.format.fill.color`<!-- -->).
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: '$all?: boolean;'
      return:
        type: boolean
  - name: axisColor
    uid: 'excel!Excel.Interfaces.DataBarConditionalFormatLoadOptions#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?: boolean;'
      return:
        type: boolean
  - name: axisFormat
    uid: 'excel!Excel.Interfaces.DataBarConditionalFormatLoadOptions#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?: boolean;'
      return:
        type: boolean
  - name: barDirection
    uid: 'excel!Excel.Interfaces.DataBarConditionalFormatLoadOptions#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?: boolean;'
      return:
        type: boolean
  - name: lowerBoundRule
    uid: 'excel!Excel.Interfaces.DataBarConditionalFormatLoadOptions#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?: boolean;'
      return:
        type: boolean
  - name: negativeFormat
    uid: 'excel!Excel.Interfaces.DataBarConditionalFormatLoadOptions#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.ConditionalDataBarNegativeFormatLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ConditionalDataBarNegativeFormatLoadOptions:interface" />'
  - name: positiveFormat
    uid: 'excel!Excel.Interfaces.DataBarConditionalFormatLoadOptions#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.ConditionalDataBarPositiveFormatLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ConditionalDataBarPositiveFormatLoadOptions:interface" />'
  - name: showDataBarOnly
    uid: 'excel!Excel.Interfaces.DataBarConditionalFormatLoadOptions#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.DataBarConditionalFormatLoadOptions#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?: boolean;'
      return:
        type: boolean