rubyXL 3.3.22 → 3.4.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/.circleci/config.yml +60 -0
- data/.codeclimate.yml +3 -0
- data/Gemfile +9 -8
- data/Gemfile.lock +124 -0
- data/LICENSE.txt +1 -1
- data/README.rdoc +54 -18
- data/Rakefile +29 -29
- data/VERSION +1 -1
- data/lib/rubyXL/cell.rb +3 -30
- data/lib/rubyXL/convenience_methods/cell.rb +276 -0
- data/lib/rubyXL/convenience_methods/color.rb +156 -0
- data/lib/rubyXL/convenience_methods/font.rb +63 -0
- data/lib/rubyXL/convenience_methods/workbook.rb +141 -0
- data/lib/rubyXL/convenience_methods/worksheet.rb +714 -0
- data/lib/rubyXL/convenience_methods.rb +5 -1045
- data/lib/rubyXL/objects/border.rb +2 -5
- data/lib/rubyXL/objects/calculation_chain.rb +4 -4
- data/lib/rubyXL/objects/cell_style.rb +9 -11
- data/lib/rubyXL/objects/chartsheet.rb +15 -19
- data/lib/rubyXL/objects/color.rb +7 -7
- data/lib/rubyXL/objects/column_range.rb +10 -13
- data/lib/rubyXL/objects/comments.rb +5 -8
- data/lib/rubyXL/objects/connection.rb +175 -0
- data/lib/rubyXL/objects/container_nodes.rb +3 -7
- data/lib/rubyXL/objects/content_types.rb +5 -8
- data/lib/rubyXL/objects/data_validation.rb +4 -4
- data/lib/rubyXL/objects/document_properties.rb +12 -16
- data/lib/rubyXL/objects/extensions.rb +19 -4
- data/lib/rubyXL/objects/external_links.rb +30 -8
- data/lib/rubyXL/objects/fill.rb +6 -9
- data/lib/rubyXL/objects/filters.rb +17 -19
- data/lib/rubyXL/objects/font.rb +4 -64
- data/lib/rubyXL/objects/formula.rb +4 -6
- data/lib/rubyXL/objects/ooxml_object.rb +25 -18
- data/lib/rubyXL/objects/query_table.rb +104 -0
- data/lib/rubyXL/objects/reference.rb +6 -8
- data/lib/rubyXL/objects/relationships.rb +13 -13
- data/lib/rubyXL/objects/root.rb +0 -2
- data/lib/rubyXL/objects/shared_strings.rb +4 -7
- data/lib/rubyXL/objects/sheet_common.rb +5 -7
- data/lib/rubyXL/objects/sheet_data.rb +50 -16
- data/lib/rubyXL/objects/simple_types.rb +21 -1
- data/lib/rubyXL/objects/storage.rb +67 -43
- data/lib/rubyXL/objects/stylesheet.rb +22 -29
- data/lib/rubyXL/objects/text.rb +12 -14
- data/lib/rubyXL/objects/theme.rb +142 -126
- data/lib/rubyXL/objects/workbook.rb +172 -64
- data/lib/rubyXL/objects/worksheet.rb +143 -128
- data/lib/rubyXL/parser.rb +1 -3
- data/lib/rubyXL/worksheet.rb +83 -78
- data/lib/rubyXL.rb +1 -1
- data/rdoc/README_rdoc.html +122 -114
- data/rdoc/RubyXL/AExtension.html +21 -60
- data/rdoc/RubyXL/AExtensionStorageArea.html +12 -17
- data/rdoc/RubyXL/ActiveX.html +154 -0
- data/rdoc/RubyXL/ActiveXBinary.html +106 -0
- data/rdoc/RubyXL/AdjustHandleList.html +13 -19
- data/rdoc/RubyXL/Alignment.html +13 -19
- data/rdoc/RubyXL/AlternateContent.html +12 -17
- data/rdoc/RubyXL/Authors.html +13 -19
- data/rdoc/RubyXL/AutoFilter.html +13 -19
- data/rdoc/RubyXL/AutoFilterColumn.html +13 -19
- data/rdoc/RubyXL/BinaryImageFile.html +12 -25
- data/rdoc/RubyXL/BodyProperties.html +13 -19
- data/rdoc/RubyXL/BooleanNode.html +12 -17
- data/rdoc/RubyXL/BooleanValue.html +12 -17
- data/rdoc/RubyXL/Border.html +25 -84
- data/rdoc/RubyXL/BorderEdge.html +20 -52
- data/rdoc/RubyXL/Borders.html +19 -39
- data/rdoc/RubyXL/Break.html +13 -19
- data/rdoc/RubyXL/BreakList.html +13 -19
- data/rdoc/RubyXL/CT_AdjPoint2D.html +13 -19
- data/rdoc/RubyXL/CT_AlphaBiLevelEffect.html +13 -19
- data/rdoc/RubyXL/CT_AlphaModulateEffect.html +13 -19
- data/rdoc/RubyXL/CT_AlphaModulateFixedEffect.html +13 -19
- data/rdoc/RubyXL/CT_AlphaOutsetEffect.html +13 -19
- data/rdoc/RubyXL/CT_AlphaReplaceEffect.html +13 -19
- data/rdoc/RubyXL/CT_Backdrop.html +13 -19
- data/rdoc/RubyXL/CT_Bevel.html +13 -19
- data/rdoc/RubyXL/CT_BiLevelEffect.html +13 -19
- data/rdoc/RubyXL/CT_BlendEffect.html +13 -19
- data/rdoc/RubyXL/CT_Blip.html +13 -19
- data/rdoc/RubyXL/CT_BlipFillProperties.html +13 -19
- data/rdoc/RubyXL/CT_BlurEffect.html +13 -19
- data/rdoc/RubyXL/CT_Camera.html +13 -19
- data/rdoc/RubyXL/CT_Color.html +13 -19
- data/rdoc/RubyXL/CT_ColorChangeEffect.html +13 -19
- data/rdoc/RubyXL/CT_ColorMapping.html +13 -19
- data/rdoc/RubyXL/CT_ColorScheme.html +13 -19
- data/rdoc/RubyXL/CT_ColorSchemeAndMapping.html +13 -19
- data/rdoc/RubyXL/CT_ConnectionSite.html +13 -19
- data/rdoc/RubyXL/CT_ConnectionSiteList.html +13 -19
- data/rdoc/RubyXL/CT_DashStop.html +13 -19
- data/rdoc/RubyXL/CT_DashStopList.html +13 -19
- data/rdoc/RubyXL/CT_DefaultShapeDefinition.html +13 -19
- data/rdoc/RubyXL/CT_DuotoneEffect.html +13 -19
- data/rdoc/RubyXL/CT_EffectContainer.html +13 -19
- data/rdoc/RubyXL/CT_EffectList.html +13 -19
- data/rdoc/RubyXL/CT_EffectReference.html +13 -19
- data/rdoc/RubyXL/CT_EffectStyleItem.html +13 -19
- data/rdoc/RubyXL/CT_EffectStyleList.html +13 -19
- data/rdoc/RubyXL/CT_EmbeddedWAVAudioFile.html +13 -19
- data/rdoc/RubyXL/CT_FillEffect.html +13 -19
- data/rdoc/RubyXL/CT_FillOverlayEffect.html +13 -19
- data/rdoc/RubyXL/CT_FillStyleList.html +13 -19
- data/rdoc/RubyXL/CT_FlatText.html +13 -19
- data/rdoc/RubyXL/CT_FontCollection.html +13 -19
- data/rdoc/RubyXL/CT_FontReference.html +13 -19
- data/rdoc/RubyXL/CT_GeomGuideList.html +13 -19
- data/rdoc/RubyXL/CT_GlowEffect.html +13 -19
- data/rdoc/RubyXL/CT_GradientFillProperties.html +13 -19
- data/rdoc/RubyXL/CT_GradientStop.html +13 -19
- data/rdoc/RubyXL/CT_GradientStopList.html +13 -19
- data/rdoc/RubyXL/CT_HSLEffect.html +13 -19
- data/rdoc/RubyXL/CT_HslColor.html +13 -19
- data/rdoc/RubyXL/CT_Hyperlink.html +13 -19
- data/rdoc/RubyXL/CT_InnerShadowEffect.html +13 -19
- data/rdoc/RubyXL/CT_LightRig.html +13 -19
- data/rdoc/RubyXL/CT_LineEndProperties.html +13 -19
- data/rdoc/RubyXL/CT_LineJoinMiterProperties.html +13 -19
- data/rdoc/RubyXL/CT_LineProperties.html +13 -19
- data/rdoc/RubyXL/CT_LineStyleList.html +13 -19
- data/rdoc/RubyXL/CT_LinearShadeProperties.html +13 -19
- data/rdoc/RubyXL/CT_LuminanceEffect.html +13 -19
- data/rdoc/RubyXL/CT_ObjectStyleDefaults.html +13 -19
- data/rdoc/RubyXL/CT_OuterShadowEffect.html +13 -19
- data/rdoc/RubyXL/CT_Path2D.html +13 -19
- data/rdoc/RubyXL/CT_Path2DArcTo.html +13 -19
- data/rdoc/RubyXL/CT_Path2DCubicBezierTo.html +13 -19
- data/rdoc/RubyXL/CT_Path2DList.html +13 -19
- data/rdoc/RubyXL/CT_Path2DQuadBezierTo.html +13 -19
- data/rdoc/RubyXL/CT_Path2DTo.html +13 -19
- data/rdoc/RubyXL/CT_PathShadeProperties.html +13 -19
- data/rdoc/RubyXL/CT_PatternFillProperties.html +13 -19
- data/rdoc/RubyXL/CT_Point3D.html +13 -19
- data/rdoc/RubyXL/CT_PolarAdjustHandle.html +13 -19
- data/rdoc/RubyXL/CT_PresetColor.html +13 -19
- data/rdoc/RubyXL/CT_PresetLineDashProperties.html +13 -19
- data/rdoc/RubyXL/CT_PresetShadowEffect.html +13 -19
- data/rdoc/RubyXL/CT_PresetTextShape.html +13 -19
- data/rdoc/RubyXL/CT_ReflectionEffect.html +13 -19
- data/rdoc/RubyXL/CT_RelativeOffsetEffect.html +13 -19
- data/rdoc/RubyXL/CT_RelativeRect.html +13 -19
- data/rdoc/RubyXL/CT_SRgbColor.html +13 -19
- data/rdoc/RubyXL/CT_ScRgbColor.html +13 -19
- data/rdoc/RubyXL/CT_Scene3D.html +13 -19
- data/rdoc/RubyXL/CT_SchemeColor.html +13 -19
- data/rdoc/RubyXL/CT_Shape3D.html +13 -19
- data/rdoc/RubyXL/CT_ShapeStyle.html +13 -19
- data/rdoc/RubyXL/CT_SoftEdgesEffect.html +13 -19
- data/rdoc/RubyXL/CT_SphereCoords.html +13 -19
- data/rdoc/RubyXL/CT_StretchInfoProperties.html +13 -19
- data/rdoc/RubyXL/CT_StyleMatrix.html +13 -19
- data/rdoc/RubyXL/CT_StyleMatrixReference.html +13 -19
- data/rdoc/RubyXL/CT_SupplementalFont.html +13 -19
- data/rdoc/RubyXL/CT_SystemColor.html +13 -19
- data/rdoc/RubyXL/CT_TextAutonumberBullet.html +13 -19
- data/rdoc/RubyXL/CT_TextBlipBullet.html +13 -19
- data/rdoc/RubyXL/CT_TextCharBullet.html +13 -19
- data/rdoc/RubyXL/CT_TextCharacterProperties.html +13 -19
- data/rdoc/RubyXL/CT_TextFont.html +13 -19
- data/rdoc/RubyXL/CT_TextListStyle.html +13 -19
- data/rdoc/RubyXL/CT_TextNormalAutofit.html +13 -19
- data/rdoc/RubyXL/CT_TextParagraphProperties.html +13 -19
- data/rdoc/RubyXL/CT_TextSpacing.html +13 -19
- data/rdoc/RubyXL/CT_TextTabStop.html +13 -19
- data/rdoc/RubyXL/CT_TextTabStopList.html +13 -19
- data/rdoc/RubyXL/CT_TileInfoProperties.html +13 -19
- data/rdoc/RubyXL/CT_TintEffect.html +13 -19
- data/rdoc/RubyXL/CT_Transform2D.html +13 -19
- data/rdoc/RubyXL/CT_TransformEffect.html +13 -19
- data/rdoc/RubyXL/CT_Vector3D.html +13 -19
- data/rdoc/RubyXL/CT_XYAdjustHandle.html +13 -19
- data/rdoc/RubyXL/CalculationChain.html +17 -45
- data/rdoc/RubyXL/CalculationChainCell.html +13 -19
- data/rdoc/RubyXL/CalculationProperties.html +13 -19
- data/rdoc/RubyXL/Cell.html +145 -205
- data/rdoc/RubyXL/CellConvenienceMethods.html +255 -460
- data/rdoc/RubyXL/CellExt.html +13 -19
- data/rdoc/RubyXL/CellSmartTag.html +13 -19
- data/rdoc/RubyXL/CellSmartTagProperty.html +13 -19
- data/rdoc/RubyXL/CellSmartTags.html +13 -19
- data/rdoc/RubyXL/CellStyle.html +13 -19
- data/rdoc/RubyXL/CellStyleXFs.html +19 -39
- data/rdoc/RubyXL/CellStyles.html +19 -39
- data/rdoc/RubyXL/CellValue.html +18 -38
- data/rdoc/RubyXL/CellWatch.html +13 -19
- data/rdoc/RubyXL/CellWatches.html +13 -19
- data/rdoc/RubyXL/CellXFs.html +20 -42
- data/rdoc/RubyXL/ChartColorsFile.html +12 -25
- data/rdoc/RubyXL/ChartFile.html +19 -49
- data/rdoc/RubyXL/ChartStyleFile.html +12 -25
- data/rdoc/RubyXL/ChartUserShapesFile.html +12 -25
- data/rdoc/RubyXL/Chartsheet.html +20 -68
- data/rdoc/RubyXL/ChartsheetPageSetup.html +13 -19
- data/rdoc/RubyXL/ChartsheetProperties.html +13 -19
- data/rdoc/RubyXL/ChartsheetProtection.html +13 -19
- data/rdoc/RubyXL/ChartsheetView.html +13 -19
- data/rdoc/RubyXL/ChartsheetViews.html +13 -19
- data/rdoc/RubyXL/Color.html +29 -40
- data/rdoc/RubyXL/ColorConvenienceClasses/HlsColor.html +242 -0
- data/rdoc/RubyXL/ColorConvenienceClasses/RgbColor.html +279 -0
- data/rdoc/RubyXL/ColorConvenienceClasses.html +91 -0
- data/rdoc/RubyXL/ColorConvenienceMethods.html +137 -0
- data/rdoc/RubyXL/ColorFilter.html +13 -19
- data/rdoc/RubyXL/ColorScale.html +13 -19
- data/rdoc/RubyXL/ColorSet.html +13 -19
- data/rdoc/RubyXL/Colors.html +13 -19
- data/rdoc/RubyXL/ColumnRange.html +23 -74
- data/rdoc/RubyXL/ColumnRanges.html +24 -83
- data/rdoc/RubyXL/Comment.html +13 -19
- data/rdoc/RubyXL/CommentList.html +13 -19
- data/rdoc/RubyXL/CommentsFile.html +18 -51
- data/rdoc/RubyXL/ConditionalFormatValue.html +13 -19
- data/rdoc/RubyXL/ConditionalFormatting.html +13 -19
- data/rdoc/RubyXL/ConditionalFormattingRule.html +13 -19
- data/rdoc/RubyXL/Connection.html +99 -0
- data/rdoc/RubyXL/ConnectionTable.html +99 -0
- data/rdoc/RubyXL/ConnectionTables.html +99 -0
- data/rdoc/RubyXL/ConnectionTextField.html +99 -0
- data/rdoc/RubyXL/ConnectionTextFields.html +99 -0
- data/rdoc/RubyXL/Connections.html +147 -0
- data/rdoc/RubyXL/ContentTypeDefault.html +12 -17
- data/rdoc/RubyXL/ContentTypeOverride.html +12 -17
- data/rdoc/RubyXL/ContentTypes.html +25 -65
- data/rdoc/RubyXL/ControlPropertiesFile.html +14 -22
- data/rdoc/RubyXL/CorePropertiesFile.html +35 -171
- data/rdoc/RubyXL/CustomColor.html +13 -19
- data/rdoc/RubyXL/CustomColorList.html +13 -19
- data/rdoc/RubyXL/CustomFilter.html +13 -19
- data/rdoc/RubyXL/CustomFilters.html +13 -19
- data/rdoc/RubyXL/CustomGeometry.html +13 -19
- data/rdoc/RubyXL/CustomProperties.html +13 -19
- data/rdoc/RubyXL/CustomPropertiesFile.html +12 -25
- data/rdoc/RubyXL/CustomProperty.html +13 -19
- data/rdoc/RubyXL/CustomPropertyFile.html +108 -0
- data/rdoc/RubyXL/CustomSheetView.html +13 -19
- data/rdoc/RubyXL/CustomSheetViews.html +13 -19
- data/rdoc/RubyXL/CustomWorkbookView.html +13 -19
- data/rdoc/RubyXL/CustomWorkbookViews.html +13 -19
- data/rdoc/RubyXL/CustomXMLFile.html +12 -22
- data/rdoc/RubyXL/DXF.html +13 -19
- data/rdoc/RubyXL/DXFs.html +13 -19
- data/rdoc/RubyXL/DataBar.html +13 -19
- data/rdoc/RubyXL/DataConsolidate.html +13 -19
- data/rdoc/RubyXL/DataConsolidationReference.html +13 -19
- data/rdoc/RubyXL/DataConsolidationReferences.html +13 -19
- data/rdoc/RubyXL/DataType.html +11 -39
- data/rdoc/RubyXL/DataValidation.html +13 -19
- data/rdoc/RubyXL/DataValidations.html +13 -19
- data/rdoc/RubyXL/DateGroupItem.html +13 -19
- data/rdoc/RubyXL/DefinedName.html +13 -19
- data/rdoc/RubyXL/DefinedNameExt.html +13 -19
- data/rdoc/RubyXL/DefinedNames.html +13 -19
- data/rdoc/RubyXL/DefinedNamesExt.html +13 -19
- data/rdoc/RubyXL/DocumentPropertiesFile.html +22 -68
- data/rdoc/RubyXL/DrawingFile.html +19 -49
- data/rdoc/RubyXL/DynamicFilter.html +13 -19
- data/rdoc/RubyXL/EmbeddedControl.html +13 -19
- data/rdoc/RubyXL/EmbeddedControls.html +13 -19
- data/rdoc/RubyXL/Extension.html +13 -19
- data/rdoc/RubyXL/ExtensionStorageArea.html +13 -19
- data/rdoc/RubyXL/Extents.html +13 -19
- data/rdoc/RubyXL/ExternalBook.html +13 -19
- data/rdoc/RubyXL/ExternalLinksFile.html +19 -49
- data/rdoc/RubyXL/ExternalReference.html +13 -19
- data/rdoc/RubyXL/ExternalReferences.html +13 -19
- data/rdoc/RubyXL/ExtraColorSchemeList.html +13 -19
- data/rdoc/RubyXL/FieldItem.html +13 -19
- data/rdoc/RubyXL/FileRecoveryProperties.html +13 -19
- data/rdoc/RubyXL/FileSharing.html +13 -19
- data/rdoc/RubyXL/FileVersion.html +13 -19
- data/rdoc/RubyXL/Fill.html +19 -39
- data/rdoc/RubyXL/Fills.html +19 -39
- data/rdoc/RubyXL/FilterContainer.html +13 -19
- data/rdoc/RubyXL/FloatNode.html +12 -17
- data/rdoc/RubyXL/FloatValue.html +12 -17
- data/rdoc/RubyXL/Font.html +20 -544
- data/rdoc/RubyXL/FontConvenienceMethods.html +414 -0
- data/rdoc/RubyXL/FontScheme.html +13 -19
- data/rdoc/RubyXL/Fonts.html +19 -39
- data/rdoc/RubyXL/Formula.html +13 -19
- data/rdoc/RubyXL/FunctionGroup.html +13 -19
- data/rdoc/RubyXL/FunctionGroups.html +13 -19
- data/rdoc/RubyXL/GenericStorageObject.html +22 -84
- data/rdoc/RubyXL/GradientFill.html +13 -19
- data/rdoc/RubyXL/HeaderFooterSettings.html +13 -19
- data/rdoc/RubyXL/Hyperlink.html +13 -19
- data/rdoc/RubyXL/HyperlinkRelFile.html +12 -22
- data/rdoc/RubyXL/Hyperlinks.html +13 -19
- data/rdoc/RubyXL/IconFilter.html +13 -19
- data/rdoc/RubyXL/IconSet.html +13 -19
- data/rdoc/RubyXL/IgnoredError.html +13 -19
- data/rdoc/RubyXL/IgnoredErrors.html +13 -19
- data/rdoc/RubyXL/IndexedColors.html +13 -19
- data/rdoc/RubyXL/InputCells.html +13 -19
- data/rdoc/RubyXL/IntegerNode.html +12 -17
- data/rdoc/RubyXL/IntegerValue.html +12 -17
- data/rdoc/RubyXL/LegacyCell.html +14 -66
- data/rdoc/RubyXL/LegacyWorksheet.html +40 -100
- data/rdoc/RubyXL/MRUColors.html +13 -19
- data/rdoc/RubyXL/MacrosFile.html +12 -25
- data/rdoc/RubyXL/MergedCell.html +13 -19
- data/rdoc/RubyXL/MergedCells.html +13 -19
- data/rdoc/RubyXL/NumFmt.html +13 -19
- data/rdoc/RubyXL/NumberFormat.html +19 -39
- data/rdoc/RubyXL/NumberFormats.html +19 -45
- data/rdoc/RubyXL/OLEObject.html +13 -19
- data/rdoc/RubyXL/OLEObjectFile.html +12 -25
- data/rdoc/RubyXL/OLEObjects.html +13 -19
- data/rdoc/RubyXL/OLESize.html +13 -19
- data/rdoc/RubyXL/OOXMLContainerObject.html +36 -132
- data/rdoc/RubyXL/OOXMLIgnored.html +163 -0
- data/rdoc/RubyXL/OOXMLObject.html +15 -25
- data/rdoc/RubyXL/OOXMLObjectClassMethods.html +92 -183
- data/rdoc/RubyXL/OOXMLObjectInstanceMethods.html +49 -185
- data/rdoc/RubyXL/OOXMLRelationshipsFile.html +48 -200
- data/rdoc/RubyXL/OOXMLTopLevelObject.html +37 -133
- data/rdoc/RubyXL/OdbcOleDbProperties.html +99 -0
- data/rdoc/RubyXL/Offset.html +13 -19
- data/rdoc/RubyXL/OlapProperties.html +99 -0
- data/rdoc/RubyXL/OleItem.html +99 -0
- data/rdoc/RubyXL/OleItems.html +99 -0
- data/rdoc/RubyXL/OleLink.html +99 -0
- data/rdoc/RubyXL/OutlineProperties.html +13 -19
- data/rdoc/RubyXL/PageMargins.html +13 -19
- data/rdoc/RubyXL/PageSetup.html +13 -19
- data/rdoc/RubyXL/PageSetupProperties.html +13 -19
- data/rdoc/RubyXL/Pane.html +13 -19
- data/rdoc/RubyXL/Parser.html +23 -56
- data/rdoc/RubyXL/PatternFill.html +13 -19
- data/rdoc/RubyXL/PhoneticProperties.html +13 -19
- data/rdoc/RubyXL/PhoneticRun.html +13 -19
- data/rdoc/RubyXL/PivotArea.html +13 -19
- data/rdoc/RubyXL/PivotCache.html +13 -19
- data/rdoc/RubyXL/PivotCacheDefinitionFile.html +14 -30
- data/rdoc/RubyXL/PivotCacheRecordsFile.html +12 -25
- data/rdoc/RubyXL/PivotCaches.html +13 -19
- data/rdoc/RubyXL/PivotReference.html +13 -19
- data/rdoc/RubyXL/PivotReferences.html +13 -19
- data/rdoc/RubyXL/PivotTableFile.html +14 -30
- data/rdoc/RubyXL/PivotTableSelection.html +13 -19
- data/rdoc/RubyXL/PresetGeometry.html +13 -19
- data/rdoc/RubyXL/PrintOptions.html +13 -19
- data/rdoc/RubyXL/PrinterSettingsFile.html +12 -25
- data/rdoc/RubyXL/ProtectedRange.html +13 -19
- data/rdoc/RubyXL/ProtectedRanges.html +13 -19
- data/rdoc/RubyXL/Protection.html +13 -19
- data/rdoc/RubyXL/QueryParameter.html +99 -0
- data/rdoc/RubyXL/QueryParameters.html +99 -0
- data/rdoc/RubyXL/QueryTable.html +155 -0
- data/rdoc/RubyXL/QueryTableDeletedField.html +99 -0
- data/rdoc/RubyXL/QueryTableDeletedFields.html +99 -0
- data/rdoc/RubyXL/QueryTableField.html +99 -0
- data/rdoc/RubyXL/QueryTableFields.html +99 -0
- data/rdoc/RubyXL/QueryTableRefresh.html +99 -0
- data/rdoc/RubyXL/RID.html +12 -17
- data/rdoc/RubyXL/RawOOXML.html +21 -60
- data/rdoc/RubyXL/Reference.html +63 -228
- data/rdoc/RubyXL/Relationship.html +12 -17
- data/rdoc/RubyXL/RelationshipSupport/ClassMehods.html +14 -32
- data/rdoc/RubyXL/RelationshipSupport.html +26 -120
- data/rdoc/RubyXL/RevisionPointer.html +99 -0
- data/rdoc/RubyXL/RichText.html +20 -39
- data/rdoc/RubyXL/RichTextRun.html +18 -38
- data/rdoc/RubyXL/Row.html +53 -152
- data/rdoc/RubyXL/RowExt.html +13 -19
- data/rdoc/RubyXL/RunProperties.html +13 -19
- data/rdoc/RubyXL/Scenario.html +13 -19
- data/rdoc/RubyXL/Scenarios.html +13 -19
- data/rdoc/RubyXL/Selection.html +19 -39
- data/rdoc/RubyXL/ShapeGuide.html +13 -19
- data/rdoc/RubyXL/ShapeTextRectangle.html +13 -19
- data/rdoc/RubyXL/SharedStringsTable.html +38 -147
- data/rdoc/RubyXL/Sheet.html +13 -19
- data/rdoc/RubyXL/SheetCalculationProperties.html +13 -19
- data/rdoc/RubyXL/SheetData.html +20 -53
- data/rdoc/RubyXL/SheetDataExt.html +13 -19
- data/rdoc/RubyXL/SheetDataSet.html +13 -19
- data/rdoc/RubyXL/SheetMetadata.html +108 -0
- data/rdoc/RubyXL/SheetName.html +13 -19
- data/rdoc/RubyXL/SheetNames.html +13 -19
- data/rdoc/RubyXL/Sheets.html +13 -19
- data/rdoc/RubyXL/SlicerCacheFile.html +12 -25
- data/rdoc/RubyXL/SlicerFile.html +12 -25
- data/rdoc/RubyXL/SmartTagProperties.html +13 -19
- data/rdoc/RubyXL/SmartTagType.html +13 -19
- data/rdoc/RubyXL/SmartTagTypes.html +13 -19
- data/rdoc/RubyXL/SmartTags.html +13 -19
- data/rdoc/RubyXL/SortCondition.html +13 -19
- data/rdoc/RubyXL/SortState.html +13 -19
- data/rdoc/RubyXL/Sqref.html +20 -53
- data/rdoc/RubyXL/Stop.html +13 -19
- data/rdoc/RubyXL/StringNode.html +12 -17
- data/rdoc/RubyXL/StringNodeW3C.html +21 -54
- data/rdoc/RubyXL/StringValue.html +12 -17
- data/rdoc/RubyXL/Stylesheet.html +35 -117
- data/rdoc/RubyXL/TableFile.html +12 -25
- data/rdoc/RubyXL/TableParts.html +12 -17
- data/rdoc/RubyXL/TableStyle.html +13 -19
- data/rdoc/RubyXL/TableStyles.html +13 -19
- data/rdoc/RubyXL/Text.html +23 -67
- data/rdoc/RubyXL/TextImportSettings.html +99 -0
- data/rdoc/RubyXL/Theme.html +57 -62
- data/rdoc/RubyXL/ThemeElements.html +13 -19
- data/rdoc/RubyXL/ThumbnailFile.html +12 -25
- data/rdoc/RubyXL/Top10.html +13 -19
- data/rdoc/RubyXL/VMLDrawingFile.html +15 -32
- data/rdoc/RubyXL/Variant.html +13 -19
- data/rdoc/RubyXL/Vector.html +18 -38
- data/rdoc/RubyXL/VectorValue.html +12 -17
- data/rdoc/RubyXL/VisualProperties.html +13 -19
- data/rdoc/RubyXL/WebPublishObject.html +13 -19
- data/rdoc/RubyXL/WebPublishObjects.html +13 -19
- data/rdoc/RubyXL/WebPublishingItem.html +13 -19
- data/rdoc/RubyXL/WebPublishingItems.html +13 -19
- data/rdoc/RubyXL/WebPublishingProperties.html +13 -19
- data/rdoc/RubyXL/WebQueryProperties.html +99 -0
- data/rdoc/RubyXL/Workbook.html +487 -227
- data/rdoc/RubyXL/WorkbookConvenienceMethods.html +163 -871
- data/rdoc/RubyXL/WorkbookProperties.html +13 -19
- data/rdoc/RubyXL/WorkbookProtection.html +13 -19
- data/rdoc/RubyXL/WorkbookRoot.html +28 -114
- data/rdoc/RubyXL/WorkbookView.html +13 -19
- data/rdoc/RubyXL/WorkbookViews.html +13 -19
- data/rdoc/RubyXL/Worksheet.html +93 -121
- data/rdoc/RubyXL/WorksheetConvenienceMethods.html +299 -1109
- data/rdoc/RubyXL/WorksheetDimensions.html +13 -19
- data/rdoc/RubyXL/WorksheetFormatProperties.html +12 -17
- data/rdoc/RubyXL/WorksheetProperties.html +13 -19
- data/rdoc/RubyXL/WorksheetProtection.html +13 -19
- data/rdoc/RubyXL/WorksheetView.html +13 -19
- data/rdoc/RubyXL/WorksheetViews.html +13 -19
- data/rdoc/RubyXL/XF.html +13 -19
- data/rdoc/RubyXL.html +41 -296
- data/rdoc/created.rid +45 -38
- data/rdoc/css/fonts.css +6 -6
- data/rdoc/css/rdoc.css +55 -6
- data/rdoc/fonts/SourceCodePro-Bold.ttf +0 -0
- data/rdoc/fonts/SourceCodePro-Regular.ttf +0 -0
- data/rdoc/index.html +44 -363
- data/rdoc/js/darkfish.js +23 -100
- data/rdoc/js/navigation.js +4 -41
- data/rdoc/js/navigation.js.gz +0 -0
- data/rdoc/js/search.js +32 -31
- data/rdoc/js/search_index.js +1 -1
- data/rdoc/js/search_index.js.gz +0 -0
- data/rdoc/js/searcher.js +7 -6
- data/rdoc/js/searcher.js.gz +0 -0
- data/rdoc/table_of_contents.html +347 -75
- data/rubyXL.gemspec +78 -43
- data/spec/lib/cell_spec.rb +115 -4
- data/spec/lib/color_spec.rb +2 -1
- data/spec/lib/parser_spec.rb +24 -27
- data/spec/lib/reference_spec.rb +9 -3
- data/spec/lib/rgb_color_spec.rb +27 -0
- data/spec/lib/stylesheet_spec.rb +8 -11
- data/spec/lib/text_spec.rb +8 -4
- data/spec/lib/workbook_spec.rb +26 -5
- data/spec/lib/worksheet_spec.rb +873 -479
- data/spec/spec_helper.rb +2 -0
- data/test/test_parse_write.rb +15 -15
- metadata +65 -10
- data/rdoc/js/jquery.js +0 -4
|
@@ -4,20 +4,23 @@
|
|
|
4
4
|
<head>
|
|
5
5
|
<meta charset="UTF-8">
|
|
6
6
|
|
|
7
|
-
<title>module RubyXL::OOXMLObjectInstanceMethods - rubyXL 3.
|
|
7
|
+
<title>module RubyXL::OOXMLObjectInstanceMethods - rubyXL 3.4.25</title>
|
|
8
8
|
|
|
9
9
|
<script type="text/javascript">
|
|
10
10
|
var rdoc_rel_prefix = "../";
|
|
11
|
+
var index_rel_prefix = "../";
|
|
11
12
|
</script>
|
|
12
13
|
|
|
13
|
-
<script src="../js/
|
|
14
|
-
<script src="../js/
|
|
14
|
+
<script src="../js/navigation.js" defer></script>
|
|
15
|
+
<script src="../js/search.js" defer></script>
|
|
16
|
+
<script src="../js/search_index.js" defer></script>
|
|
17
|
+
<script src="../js/searcher.js" defer></script>
|
|
18
|
+
<script src="../js/darkfish.js" defer></script>
|
|
15
19
|
|
|
16
20
|
<link href="../css/fonts.css" rel="stylesheet">
|
|
17
21
|
<link href="../css/rdoc.css" rel="stylesheet">
|
|
18
22
|
|
|
19
23
|
|
|
20
|
-
|
|
21
24
|
<body id="top" role="document" class="module">
|
|
22
25
|
<nav role="navigation">
|
|
23
26
|
<div id="project-navigation">
|
|
@@ -56,40 +59,29 @@
|
|
|
56
59
|
|
|
57
60
|
|
|
58
61
|
|
|
59
|
-
|
|
62
|
+
|
|
63
|
+
<div id="extends-section" class="nav-section">
|
|
60
64
|
<h3>Extended With Modules</h3>
|
|
61
65
|
|
|
62
66
|
<ul class="link-list">
|
|
63
|
-
|
|
64
|
-
|
|
65
67
|
<li><a class="extend" href="OOXMLObjectClassMethods.html">RubyXL::OOXMLObjectClassMethods</a>
|
|
66
|
-
|
|
67
|
-
|
|
68
68
|
</ul>
|
|
69
69
|
</div>
|
|
70
70
|
|
|
71
|
-
|
|
71
|
+
|
|
72
|
+
<!-- Method Quickref -->
|
|
72
73
|
<div id="method-list-section" class="nav-section">
|
|
73
74
|
<h3>Methods</h3>
|
|
74
75
|
|
|
75
76
|
<ul class="link-list" role="directory">
|
|
76
|
-
|
|
77
77
|
<li ><a href="#method-c-included">::included</a>
|
|
78
|
-
|
|
79
78
|
<li ><a href="#method-c-new">::new</a>
|
|
80
|
-
|
|
81
79
|
<li ><a href="#method-i-3D-3D">#==</a>
|
|
82
|
-
|
|
83
80
|
<li ><a href="#method-i-before_write_xml">#before_write_xml</a>
|
|
84
|
-
|
|
85
81
|
<li ><a href="#method-i-get_node_object">#get_node_object</a>
|
|
86
|
-
|
|
87
82
|
<li ><a href="#method-i-index_in_collection">#index_in_collection</a>
|
|
88
|
-
|
|
89
83
|
<li ><a href="#method-i-init_child_nodes">#init_child_nodes</a>
|
|
90
|
-
|
|
91
84
|
<li ><a href="#method-i-write_xml">#write_xml</a>
|
|
92
|
-
|
|
93
85
|
</ul>
|
|
94
86
|
</div>
|
|
95
87
|
|
|
@@ -105,23 +97,15 @@
|
|
|
105
97
|
|
|
106
98
|
</section>
|
|
107
99
|
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
100
|
<section id="5Buntitled-5D" class="documentation-section">
|
|
112
|
-
|
|
113
101
|
|
|
114
|
-
|
|
115
102
|
|
|
116
|
-
|
|
117
103
|
|
|
118
|
-
|
|
119
104
|
<section class="attribute-method-details" class="method-section">
|
|
120
105
|
<header>
|
|
121
106
|
<h3>Attributes</h3>
|
|
122
107
|
</header>
|
|
123
108
|
|
|
124
|
-
|
|
125
109
|
<div id="attribute-i-local_namespaces" class="method-detail">
|
|
126
110
|
<div class="method-heading attribute-method-heading">
|
|
127
111
|
<span class="method-name">local_namespaces</span><span
|
|
@@ -130,76 +114,52 @@
|
|
|
130
114
|
|
|
131
115
|
<div class="method-description">
|
|
132
116
|
|
|
133
|
-
|
|
134
|
-
|
|
135
117
|
</div>
|
|
136
118
|
</div>
|
|
137
|
-
|
|
138
119
|
</section>
|
|
139
|
-
|
|
140
120
|
|
|
141
|
-
|
|
121
|
+
|
|
142
122
|
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
143
123
|
<header>
|
|
144
124
|
<h3>Public Class Methods</h3>
|
|
145
125
|
</header>
|
|
146
126
|
|
|
147
|
-
|
|
148
127
|
<div id="method-c-included" class="method-detail ">
|
|
149
|
-
|
|
150
128
|
<div class="method-heading">
|
|
151
129
|
<span class="method-name">included</span><span
|
|
152
130
|
class="method-args">(klass)</span>
|
|
153
|
-
|
|
154
131
|
<span class="method-click-advice">click to toggle source</span>
|
|
155
|
-
|
|
156
132
|
</div>
|
|
157
|
-
|
|
158
133
|
|
|
159
134
|
<div class="method-description">
|
|
160
135
|
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
136
|
|
|
165
|
-
|
|
166
137
|
<div class="method-source-code" id="included-source">
|
|
167
|
-
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line
|
|
168
|
-
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">included</span>(<span class="ruby-identifier">klass</span>)
|
|
138
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 217</span>
|
|
139
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">included</span>(<span class="ruby-identifier">klass</span>)
|
|
169
140
|
<span class="ruby-identifier">klass</span>.<span class="ruby-identifier">extend</span> <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">OOXMLObjectClassMethods</span>
|
|
170
141
|
<span class="ruby-keyword">end</span></pre>
|
|
171
142
|
</div>
|
|
172
|
-
|
|
173
143
|
</div>
|
|
174
144
|
|
|
175
|
-
|
|
176
145
|
|
|
177
|
-
|
|
178
146
|
</div>
|
|
179
147
|
|
|
180
|
-
|
|
181
148
|
<div id="method-c-new" class="method-detail ">
|
|
182
|
-
|
|
183
149
|
<div class="method-heading">
|
|
184
150
|
<span class="method-name">new</span><span
|
|
185
|
-
class="method-args">(params =
|
|
186
|
-
|
|
151
|
+
class="method-args">(params = nil)</span>
|
|
187
152
|
<span class="method-click-advice">click to toggle source</span>
|
|
188
|
-
|
|
189
153
|
</div>
|
|
190
|
-
|
|
191
154
|
|
|
192
155
|
<div class="method-description">
|
|
193
156
|
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
157
|
|
|
198
|
-
|
|
199
158
|
<div class="method-source-code" id="new-source">
|
|
200
|
-
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line
|
|
201
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">params</span> =
|
|
159
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 226</span>
|
|
160
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">params</span> = <span class="ruby-keyword">nil</span>)
|
|
202
161
|
<span class="ruby-ivar">@local_namespaces</span> = <span class="ruby-keyword">nil</span>
|
|
162
|
+
<span class="ruby-identifier">params</span> <span class="ruby-operator">||=</span> {}
|
|
203
163
|
|
|
204
164
|
<span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_attributes</span>).<span class="ruby-identifier">each_value</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
|
|
205
165
|
<span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-node">"@#{v[:accessor]}"</span>, <span class="ruby-identifier">params</span>[<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>]]) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">v</span>[<span class="ruby-value">:computed</span>]
|
|
@@ -208,82 +168,54 @@
|
|
|
208
168
|
<span class="ruby-identifier">init_child_nodes</span>(<span class="ruby-identifier">params</span>)
|
|
209
169
|
<span class="ruby-keyword">end</span></pre>
|
|
210
170
|
</div>
|
|
211
|
-
|
|
212
171
|
</div>
|
|
213
172
|
|
|
214
|
-
|
|
215
173
|
|
|
216
|
-
|
|
217
174
|
</div>
|
|
218
175
|
|
|
219
|
-
|
|
220
176
|
</section>
|
|
221
|
-
|
|
177
|
+
|
|
222
178
|
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
223
179
|
<header>
|
|
224
180
|
<h3>Public Instance Methods</h3>
|
|
225
181
|
</header>
|
|
226
182
|
|
|
227
|
-
|
|
228
183
|
<div id="method-i-3D-3D" class="method-detail ">
|
|
229
|
-
|
|
230
184
|
<div class="method-heading">
|
|
231
185
|
<span class="method-name">==</span><span
|
|
232
186
|
class="method-args">(other)</span>
|
|
233
|
-
|
|
234
187
|
<span class="method-click-advice">click to toggle source</span>
|
|
235
|
-
|
|
236
188
|
</div>
|
|
237
|
-
|
|
238
189
|
|
|
239
190
|
<div class="method-description">
|
|
240
191
|
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
192
|
|
|
245
|
-
|
|
246
193
|
<div class="method-source-code" id="3D-3D-source">
|
|
247
|
-
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line
|
|
248
|
-
<span class="ruby-keyword">def</span> <span class="ruby-
|
|
194
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 255</span>
|
|
195
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">==</span>(<span class="ruby-identifier">other</span>)
|
|
249
196
|
<span class="ruby-identifier">other</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>) <span class="ruby-operator">&&</span>
|
|
250
197
|
<span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_attributes</span>).<span class="ruby-identifier">all?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>]) <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>]) } <span class="ruby-operator">&&</span>
|
|
251
198
|
<span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_child_nodes</span>).<span class="ruby-identifier">all?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>]) <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>]) }
|
|
252
199
|
<span class="ruby-keyword">end</span></pre>
|
|
253
200
|
</div>
|
|
254
|
-
|
|
255
201
|
</div>
|
|
256
202
|
|
|
257
|
-
|
|
258
203
|
|
|
259
|
-
|
|
260
204
|
</div>
|
|
261
205
|
|
|
262
|
-
|
|
263
206
|
<div id="method-i-before_write_xml" class="method-detail ">
|
|
264
|
-
|
|
265
207
|
<div class="method-heading">
|
|
266
208
|
<span class="method-name">before_write_xml</span><span
|
|
267
209
|
class="method-args">()</span>
|
|
268
|
-
|
|
269
210
|
<span class="method-click-advice">click to toggle source</span>
|
|
270
|
-
|
|
271
211
|
</div>
|
|
272
|
-
|
|
273
212
|
|
|
274
213
|
<div class="method-description">
|
|
275
|
-
|
|
276
|
-
<p>Subclass provided filter to perform last-minute operations (cleanup, count,
|
|
277
|
-
etc.) immediately prior to write, along with option to terminate the actual
|
|
278
|
-
write if <code>false</code> is returned (for example, to avoid writing the
|
|
279
|
-
collection's root node if the collection is empty).</p>
|
|
280
|
-
|
|
281
|
-
|
|
214
|
+
<p>Subclass provided filter to perform last-minute operations (cleanup, count, etc.) immediately prior to write, along with option to terminate the actual write if <code>false</code> is returned (for example, to avoid writing the collection’s root node if the collection is empty).</p>
|
|
282
215
|
|
|
283
|
-
|
|
284
216
|
<div class="method-source-code" id="before_write_xml-source">
|
|
285
|
-
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line
|
|
286
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">before_write_xml</span>
|
|
217
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 355</span>
|
|
218
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">before_write_xml</span>
|
|
287
219
|
<span class="ruby-comment">#TODO# This will go away once containers are fully implemented.</span>
|
|
288
220
|
<span class="ruby-identifier">child_nodes</span> = <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_child_nodes</span>)
|
|
289
221
|
<span class="ruby-identifier">child_nodes</span>.<span class="ruby-identifier">each_pair</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">child_node_name</span>, <span class="ruby-identifier">child_node_params</span><span class="ruby-operator">|</span>
|
|
@@ -292,80 +224,47 @@ collection's root node if the collection is empty).</p>
|
|
|
292
224
|
<span class="ruby-keyword">true</span>
|
|
293
225
|
<span class="ruby-keyword">end</span></pre>
|
|
294
226
|
</div>
|
|
295
|
-
|
|
296
227
|
</div>
|
|
297
228
|
|
|
298
|
-
|
|
299
229
|
|
|
300
|
-
|
|
301
230
|
</div>
|
|
302
231
|
|
|
303
|
-
|
|
304
232
|
<div id="method-i-index_in_collection" class="method-detail ">
|
|
305
|
-
|
|
306
233
|
<div class="method-heading">
|
|
307
234
|
<span class="method-name">index_in_collection</span><span
|
|
308
235
|
class="method-args">()</span>
|
|
309
|
-
|
|
310
236
|
<span class="method-click-advice">click to toggle source</span>
|
|
311
|
-
|
|
312
237
|
</div>
|
|
313
|
-
|
|
314
238
|
|
|
315
239
|
<div class="method-description">
|
|
316
|
-
|
|
317
|
-
<p>Prototype method. For sparse collections (<code>Rows</code>,
|
|
318
|
-
<code>Cells</code>, etc.) must return index at which this object is
|
|
319
|
-
expected to reside in the collection. If <code>nil</code> is returned, then
|
|
320
|
-
object is simply added to the end of the collection.</p>
|
|
321
|
-
|
|
322
|
-
|
|
240
|
+
<p>Prototype method. For sparse collections (<code>Rows</code>, <code>Cells</code>, etc.) must return index at which this object is expected to reside in the collection. If <code>nil</code> is returned, then object is simply added to the end of the collection.</p>
|
|
323
241
|
|
|
324
|
-
|
|
325
242
|
<div class="method-source-code" id="index_in_collection-source">
|
|
326
|
-
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line
|
|
327
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">index_in_collection</span>
|
|
243
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 343</span>
|
|
244
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">index_in_collection</span>
|
|
328
245
|
<span class="ruby-keyword">nil</span>
|
|
329
246
|
<span class="ruby-keyword">end</span></pre>
|
|
330
247
|
</div>
|
|
331
|
-
|
|
332
248
|
</div>
|
|
333
249
|
|
|
334
|
-
|
|
335
250
|
|
|
336
|
-
|
|
337
251
|
</div>
|
|
338
252
|
|
|
339
|
-
|
|
340
253
|
<div id="method-i-write_xml" class="method-detail ">
|
|
341
|
-
|
|
342
254
|
<div class="method-heading">
|
|
343
255
|
<span class="method-name">write_xml</span><span
|
|
344
256
|
class="method-args">(xml = nil, node_name_override = nil)</span>
|
|
345
|
-
|
|
346
257
|
<span class="method-click-advice">click to toggle source</span>
|
|
347
|
-
|
|
348
258
|
</div>
|
|
349
|
-
|
|
350
259
|
|
|
351
260
|
<div class="method-description">
|
|
352
|
-
|
|
353
|
-
<p>Recursively write the OOXML object and all its children out as
|
|
354
|
-
Nokogiri::XML. Immediately before the actual generation,
|
|
355
|
-
+before_write_xml()+ is called to perform last-minute cleanup and
|
|
356
|
-
validation operations; if it returns <code>false</code>, an empty string is
|
|
357
|
-
returned (rather than <code>nil</code>, so Nokogiri::XML's
|
|
358
|
-
<code>&lt;&lt;</code> operator can be used without additional
|
|
359
|
-
<code>nil</code> checking)</p>
|
|
261
|
+
<p>Recursively write the OOXML object and all its children out as Nokogiri::XML. Immediately before the actual generation, +before_write_xml()+ is called to perform last-minute cleanup and validation operations; if it returns <code>false</code>, an empty string is returned (rather than <code>nil</code>, so Nokogiri::XML’s <code>&lt;&lt;</code> operator can be used without additional <code>nil</code> checking)</p>
|
|
360
262
|
|
|
361
263
|
<h3 id="method-i-write_xml-label-Parameters">Parameters<span><a href="#method-i-write_xml-label-Parameters">¶</a> <a href="#top">↑</a></span></h3>
|
|
362
264
|
<ul><li>
|
|
363
|
-
<p><code>xml</code> - Base Nokogiri::XML object used for building. If omitted,
|
|
364
|
-
a blank document will be generated.</p>
|
|
265
|
+
<p><code>xml</code> - Base Nokogiri::XML object used for building. If omitted, a blank document will be generated.</p>
|
|
365
266
|
</li><li>
|
|
366
|
-
<p><code>node_name_override</code> - if present, is used instead of the
|
|
367
|
-
default element name for this object provided by
|
|
368
|
-
<code>define_element_name</code></p>
|
|
267
|
+
<p><code>node_name_override</code> - if present, is used instead of the default element name for this object provided by <code>define_element_name</code></p>
|
|
369
268
|
</li></ul>
|
|
370
269
|
|
|
371
270
|
<h4 id="method-i-write_xml-label-Examples">Examples<span><a href="#method-i-write_xml-label-Examples">¶</a> <a href="#top">↑</a></span></h4>
|
|
@@ -373,38 +272,33 @@ default element name for this object provided by
|
|
|
373
272
|
<pre class="ruby"><span class="ruby-identifier">obj</span>.<span class="ruby-identifier">write_xml</span>()
|
|
374
273
|
</pre>
|
|
375
274
|
|
|
376
|
-
<p>Creates a new empty <code>Nokogiri::XML</code>, populates it with the OOXML
|
|
377
|
-
structure as described in the respective definition, and returns the
|
|
378
|
-
resulting <code>Nokogiri::XML</code> object.</p>
|
|
275
|
+
<p>Creates a new empty <code>Nokogiri::XML</code>, populates it with the OOXML structure as described in the respective definition, and returns the resulting <code>Nokogiri::XML</code> object.</p>
|
|
379
276
|
|
|
380
277
|
<pre class="ruby"><span class="ruby-identifier">obj</span>.<span class="ruby-identifier">write_xml</span>(<span class="ruby-identifier">seed_xml</span>)
|
|
381
278
|
</pre>
|
|
382
279
|
|
|
383
|
-
<p>Using the passed-in <code>Nokogiri</code> <code>xml</code> object, creates
|
|
384
|
-
a new element corresponding to <code>obj</code> according to its
|
|
385
|
-
definition, along with all its properties and children, and returns the
|
|
386
|
-
newly created element.</p>
|
|
280
|
+
<p>Using the passed-in <code>Nokogiri</code> <code>xml</code> object, creates a new element corresponding to <code>obj</code> according to its definition, along with all its properties and children, and returns the newly created element.</p>
|
|
387
281
|
|
|
388
282
|
<pre class="ruby"><span class="ruby-identifier">obj</span>.<span class="ruby-identifier">write_xml</span>(<span class="ruby-identifier">seed_xml</span>, <span class="ruby-string">'overriden_element_name'</span>)
|
|
389
283
|
</pre>
|
|
390
284
|
|
|
391
|
-
<p>Same as above, but uses the passed-in <code>node_name_override</code> as
|
|
392
|
-
the new element name, instead of its default name set by
|
|
393
|
-
<code>define_element_name</code>.</p>
|
|
394
|
-
|
|
395
|
-
|
|
285
|
+
<p>Same as above, but uses the passed-in <code>node_name_override</code> as the new element name, instead of its default name set by <code>define_element_name</code>.</p>
|
|
396
286
|
|
|
397
|
-
|
|
398
287
|
<div class="method-source-code" id="write_xml-source">
|
|
399
|
-
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line
|
|
400
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">write_xml</span>(<span class="ruby-identifier">xml</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">node_name_override</span> = <span class="ruby-keyword">nil</span>)
|
|
288
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 275</span>
|
|
289
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_xml</span>(<span class="ruby-identifier">xml</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">node_name_override</span> = <span class="ruby-keyword">nil</span>)
|
|
401
290
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword">then</span>
|
|
402
291
|
<span class="ruby-identifier">seed_xml</span> = <span class="ruby-constant">Nokogiri</span><span class="ruby-operator">::</span><span class="ruby-constant">XML</span>(<span class="ruby-string">'<?xml version = "1.0" standalone ="yes"?>'</span>)
|
|
403
292
|
<span class="ruby-identifier">seed_xml</span>.<span class="ruby-identifier">encoding</span> = <span class="ruby-string">'UTF-8'</span>
|
|
293
|
+
|
|
294
|
+
<span class="ruby-keyword">if</span> <span class="ruby-constant">Nokogiri</span>.<span class="ruby-identifier">jruby?</span> <span class="ruby-keyword">then</span> <span class="ruby-comment"># Issue 188 workaround for JRuby</span>
|
|
295
|
+
<span class="ruby-identifier">seed_xml</span>.<span class="ruby-identifier">to_java</span>.<span class="ruby-identifier">strict_error_checking</span> = <span class="ruby-keyword">false</span>
|
|
296
|
+
<span class="ruby-keyword">end</span>
|
|
297
|
+
|
|
404
298
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">write_xml</span>(<span class="ruby-identifier">seed_xml</span>)
|
|
405
299
|
<span class="ruby-keyword">return</span> <span class="ruby-identifier">result</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">result</span> <span class="ruby-operator">==</span> <span class="ruby-string">''</span>
|
|
406
300
|
<span class="ruby-identifier">seed_xml</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">result</span>
|
|
407
|
-
<span class="ruby-keyword">return</span> <span class="ruby-identifier">seed_xml</span>.<span class="ruby-identifier">to_xml</span>({ <span class="ruby-value">:indent</span>
|
|
301
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">seed_xml</span>.<span class="ruby-identifier">to_xml</span>({ <span class="ruby-value">:indent</span> <span class="ruby-operator">=></span> <span class="ruby-value">0</span>, <span class="ruby-value">:save_with</span> <span class="ruby-operator">=></span> <span class="ruby-constant">Nokogiri</span><span class="ruby-operator">::</span><span class="ruby-constant">XML</span><span class="ruby-operator">::</span><span class="ruby-constant">Node</span><span class="ruby-operator">::</span><span class="ruby-constant">SaveOptions</span><span class="ruby-operator">::</span><span class="ruby-constant">AS_XML</span> })
|
|
408
302
|
<span class="ruby-keyword">end</span>
|
|
409
303
|
|
|
410
304
|
<span class="ruby-keyword">return</span> <span class="ruby-string">''</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">before_write_xml</span>
|
|
@@ -457,79 +351,53 @@ the new element name, instead of its default name set by
|
|
|
457
351
|
<span class="ruby-identifier">elem</span>
|
|
458
352
|
<span class="ruby-keyword">end</span></pre>
|
|
459
353
|
</div>
|
|
460
|
-
|
|
461
354
|
</div>
|
|
462
355
|
|
|
463
|
-
|
|
464
356
|
|
|
465
|
-
|
|
466
357
|
</div>
|
|
467
358
|
|
|
468
|
-
|
|
469
359
|
</section>
|
|
470
|
-
|
|
360
|
+
|
|
471
361
|
<section id="protected-instance-5Buntitled-5D-method-details" class="method-section">
|
|
472
362
|
<header>
|
|
473
363
|
<h3>Protected Instance Methods</h3>
|
|
474
364
|
</header>
|
|
475
365
|
|
|
476
|
-
|
|
477
366
|
<div id="method-i-get_node_object" class="method-detail ">
|
|
478
|
-
|
|
479
367
|
<div class="method-heading">
|
|
480
368
|
<span class="method-name">get_node_object</span><span
|
|
481
369
|
class="method-args">(child_node_params)</span>
|
|
482
|
-
|
|
483
370
|
<span class="method-click-advice">click to toggle source</span>
|
|
484
|
-
|
|
485
371
|
</div>
|
|
486
|
-
|
|
487
372
|
|
|
488
373
|
<div class="method-description">
|
|
489
374
|
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
375
|
|
|
494
|
-
|
|
495
376
|
<div class="method-source-code" id="get_node_object-source">
|
|
496
|
-
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line
|
|
497
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_node_object</span>(<span class="ruby-identifier">child_node_params</span>)
|
|
377
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 347</span>
|
|
378
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_node_object</span>(<span class="ruby-identifier">child_node_params</span>)
|
|
498
379
|
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">child_node_params</span>[<span class="ruby-value">:accessor</span>])
|
|
499
380
|
<span class="ruby-keyword">end</span></pre>
|
|
500
381
|
</div>
|
|
501
|
-
|
|
502
382
|
</div>
|
|
503
383
|
|
|
504
|
-
|
|
505
384
|
|
|
506
|
-
|
|
507
385
|
</div>
|
|
508
386
|
|
|
509
|
-
|
|
510
387
|
<div id="method-i-init_child_nodes" class="method-detail ">
|
|
511
|
-
|
|
512
388
|
<div class="method-heading">
|
|
513
389
|
<span class="method-name">init_child_nodes</span><span
|
|
514
390
|
class="method-args">(params)</span>
|
|
515
|
-
|
|
516
391
|
<span class="method-click-advice">click to toggle source</span>
|
|
517
|
-
|
|
518
392
|
</div>
|
|
519
|
-
|
|
520
393
|
|
|
521
394
|
<div class="method-description">
|
|
522
395
|
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
396
|
|
|
527
|
-
|
|
528
397
|
<div class="method-source-code" id="init_child_nodes-source">
|
|
529
|
-
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line
|
|
530
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">init_child_nodes</span>(<span class="ruby-identifier">params</span>)
|
|
398
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 237</span>
|
|
399
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">init_child_nodes</span>(<span class="ruby-identifier">params</span>)
|
|
531
400
|
<span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_child_nodes</span>).<span class="ruby-identifier">each_value</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
|
|
532
|
-
|
|
533
401
|
<span class="ruby-identifier">initial_value</span> =
|
|
534
402
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>]) <span class="ruby-keyword">then</span> <span class="ruby-identifier">params</span>[<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>]]
|
|
535
403
|
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">v</span>[<span class="ruby-value">:is_array</span>] <span class="ruby-keyword">then</span> []
|
|
@@ -540,24 +408,20 @@ the new element name, instead of its default name set by
|
|
|
540
408
|
}
|
|
541
409
|
<span class="ruby-keyword">end</span></pre>
|
|
542
410
|
</div>
|
|
543
|
-
|
|
544
411
|
</div>
|
|
545
412
|
|
|
546
|
-
|
|
547
413
|
|
|
548
|
-
|
|
549
414
|
</div>
|
|
550
415
|
|
|
551
|
-
|
|
552
416
|
</section>
|
|
553
|
-
|
|
417
|
+
|
|
554
418
|
</section>
|
|
555
419
|
</main>
|
|
556
420
|
|
|
557
421
|
|
|
558
422
|
<footer id="validator-badges" role="contentinfo">
|
|
559
|
-
<p><a href="
|
|
560
|
-
<p>Generated by <a href="
|
|
423
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
424
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.
|
|
561
425
|
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
562
426
|
</footer>
|
|
563
427
|
|